Mode d'emploi de l'API de Joomag

Joomag fournit une API qui peut être utilisée par des applications tierces pour gérer le compte Joomag. Par exemple, elle peut être utilisée pour créer des magazines à partir de fichiers PDF. L'API est basée sur le protocole HTTP avec les réponses JSON.

Toutes les requêtes doivent être soumises en utilisant HTML POST à l'URL suivante :
http://www.joomag.com/Frontend/WebService/restAPI.php

La classe de client API PHP peut être téléchargée à partir de Client API PHP.

Créer des magazines à partir d'un PDF

Créez une nouvelle publication sur Joomag à partir d'un fichier PDF.

Paramètres

Paramètre Requis Description
key La clé API de votre compte. Vous pouvez l'obtenir dans Mon compte > Paramètres.
action Doit être au niveau vérification de l'état du PDF
pdf Fichier PDF posté sous le code « Données à parties/formes multiples »
magazine_ID L'ID unique du magazine dans lequel vous souhaitez créer le numéro. Il peut être éventuellement retrouver ici.
volume Le volume de la nouvelle édition
description La description du numéro nouvellement créé
keywords Liste de mots-clés séparés d'une virgule
allow_print Drapeau indiquant si l'autorisation d'impression du numéro est accordée. Son statut correspond à 0 ou à 1 (0 par défaut).

Réponse

Renvoie l'ID temporaire du nouveau numéro créé. Il peut être utilisé par la suite pour récupérer l'état de la conversion.

Exemple de réponse:
        {
            "error" : 0,
            "msg" : "",
            "response" : {
                "issueTempID" : "6d8b27d868843a6ebaa8a5f44d7accb8"
            }
        }
            

Vérification du statut du PDF

Obtenez le statut du fichier PDF.

Paramètres

Paramètre Requis Description
key La clé API de votre compte. Vous pouvez l'obtenir dans Mon compte > Paramètres.
action Devrait être voir statut du PDF

Réponse

Renvoie le statut du fichier PDF. Si le fichier PDF est prêt, l'URL et l'identifiant sont renvoyés.

Statuts
Valeur Description
ready La conversion en PDF a bien été effectuée et le numéro est prêt à être lu.
error Une erreur est survenue lors de la conversion du fichier PDF
pending La conversion en PDF est en cours
Exemple de réponse:
        {
            "error" : 0,
            "msg" : "",
            "response" : {
                "status" : "ready",
                "code" : "2",
                "url" : "http:\/\/www.joomag.com\/magazine\/mag\/0379014001353947680",
                "issue_ID" : "0379014001353947680"
            }
        }
            

Obtenir la liste des magazines

Retrouvez la liste de tous les magazines de votre compte.

Paramètres

Paramètre Requis Description
key La clé API de votre compte. Vous pouvez l'obtenir dans Mon compte > Paramètres.
action Il y a {0} listMagazines {1}

Réponse

Renvoie la liste des magazines dans votre compte.

Objet magazine
Valeur Description
title Titre du magazine
ID ID du magazine
url URL du magazine. Contiendra le dernier numéro paru
Exemple de réponse:
        {
            "error" : 0,
            "msg" :   "",
            "response" : {
                "magazines" : [{
                        "title" :   "Healty Live",
                        "ID" :   "M0379014001353530983",
                        "url" :   "http:\/\/www.joomag.com\/magazine\/healty-live\/M0379014001353530983"
                    }, {
                        "title" :   "Sports and Fitness",
                        "ID" :   "M0812158001353446983",
                        "url" :   "http:\/\/www.joomag.com\/magazine\/sports-and-fitness\/M0812158001353446983",
                }]
            }
        }
            

Obtenir la liste des numéros

Récupérez la liste des numéros du magazine spécifié.

Paramètres

Paramètre Requis Description
key La clé API de votre compte. Vous pouvez l'obtenir dans Mon compte > Paramètres.
action Devrait être {0}listIssues{1}
magazine_ID L'ID unique du magazine dans lequel vous souhaitez créer le numéro. Il peut être éventuellement retrouver ici.
include_tags Si fourni et a une valeur booléenne évaluée à vrai, renverra une liste de balises séparées par une virgule pour chaque publication.

Réponse

Retourne la liste des publications du magazine donné.

Objet du numéro
Valeur Description
title Titre de la publication
volume Volume de la publication
ID ID de la publication
url URL du numéro
cover Aperçu miniature de l'adresse URL de la Une du numéro
pages Nombre de pages
tags Liste des mots-clés, séparés par une virgule, du numéro. Présente uniquement si l'indicateur « include_tags » est publié
Exemple de réponse:
        {
            "error" : 0,
            "msg" :   "",
            "response" : {
                "issues" : [{
                        "title" :   "Healty Live Vol. 1",
                        "volume" : "Vol. 1",
                        "ID" :   "0379014001353530983",
                        "url" :   "http:\/\/www.joomag.com\/magazine\/healty-live-vol-1\/0379014001353530983",
                        "cover" : "http:\/\/s1.joomag.com\/res_mag\/0\/8\/8556\/89385\/thumbs\/1762436.jpg",
                        "pages" : 24,
                        "tags" : "Present,only,if,include_tags,flag,is,posted"
                    }, {
                        "title" :   "Healty Live Vol. 2",
                        "volume" : "Vol. 2",
                        "ID" :   "0812158001353446983",
                        "url" :   "http:\/\/www.joomag.com\/magazine\/healty-live-vol-2\/0812158001353446983",
                        "cover" : "http:\/\/s1.joomag.com\/res_mag\/0\/8\/8556\/89385\/thumbs\/1762437.jpg",
                        "pages" : 28,
                        "tags" : "Present,only,if,include_tags,flag,is,posted"
                    }, {
                        "title" :   "Healty Live Vol. 3",
                        "volume" : "Vol. 3",
                        "ID" :   "0453041001369593634",
                        "url" :   "http:\/\/www.joomag.com\/magazine\/healty-live-vol-3\/0453041001369593634",
                        "cover" : "http:\/\/s1.joomag.com\/res_mag\/0\/8\/8556\/89385\/thumbs\/1762438.jpg",
                        "pages" : 30,
                        "tags" : "Present,only,if,include_tags,flag,is,posted"
                }]
            }
        }