Manual API Joomag

Joomag proporciona un API, que puede ser utilizado para administar la cuenta Joomag por aplicaciones de 3ºs. Por ejemplo, Puede ser usada para la creación de revistas partiendo de un archivo PDF. La API está basada en el protocolo HTTP con las respuesas JSON.

Todas las solicitudes deberán ser presentadas utilizando HTML POST en la siguiente URL:
http://www.joomag.com/Frontend/WebService/restAPI.php

La clase de cliente PHP API puede ser descargada desde Cliente PHP API.

Creando revistas desde PDF

Crear una nueva publicación en Joomag desde un archivo PDF.

Parámetros

Parámetro Necesario Descripción
key La clave API de su cuenta. Puede conseguirla desde Mi cuenta > Ajustes.
action Debe ser checkPDFStatus
pdf Archivo PDF publicado con la codificación “multipart/form-data”
magazine_ID ID único de la revista donde desea crear la edición. Este puede ser recuperado desde aquí.
volume El volumen de la edición recientemente creada
description La descripción de la edición recientemente creada.
keywords La lista de palabras claves está separadas por comas.
allow_print Bandera, indicando si se permite la impresión de la edición o no. Puede ser 1 o 0. (Por defecto 0)

Respuesta

Devolver el ID temporal de la edición recientemente creada. Puede ser utilizada más tarde para la recuperación del estado de conversión.

Ejemplo de respuesta:
        {
            "error" : 0,
            "msg" : "",
            "response" : {
                "issueTempID" : "6d8b27d868843a6ebaa8a5f44d7accb8"
            }
        }
            

Comprobando estado del PDF

Obtenga el estado del archivo PDF.

Parámetros

Parámetro Necesario Descripción
key La clave API de su cuenta. Puede conseguirla desde Mi cuenta > Ajustes.
action Debe ser checkPDFStatus

Respuesta

Volver a cambiar el estado del archivo PDF. Si el PDF está preparado, la URL y el ID volverán a cambiar.

Estados
Valor Descripción
ready La conversión del PDF ha sido completada con éxito y la edición está lista para ser vista.
error Un error ha ocurrido mientras se convertía el archivo PDF
pending La conversión del PDF está en proceso
Ejemplo de respuesta:
        {
            "error" : 0,
            "msg" : "",
            "response" : {
                "status" : "ready",
                "code" : "2",
                "url" : "http:\/\/www.joomag.com\/magazine\/mag\/0379014001353947680",
                "issue_ID" : "0379014001353947680"
            }
        }
            

Obtener la lista de las Revistas

Recuperar la lista de todas las Revistas en tu cuenta.

Parámetros

Parámetro Necesario Descripción
key La clave API de su cuenta. Puede conseguirla desde Mi cuenta > Ajustes.
action Debe ser listMagazines

Respuesta

Recuperar la lista de las Revistas en tu cuenta.

Objetivo de la Revista
Valor Descripción
title Título de la Revista
ID ID de la Revista
url URL de la revista. Contendrá el último número publicado
Ejemplo de respuesta:
        {
            "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",
                }]
            }
        }
            

Obtener la lista de Ediciones

Recuperar la lista de edición en la revista específica.

Parámetros

Parámetro Necesario Descripción
key La clave API de su cuenta. Puede conseguirla desde Mi cuenta > Ajustes.
action Debe ser listIssues
magazine_ID ID único de la revista donde desea crear la edición. Este puede ser recuperado desde aquí.
include_tags Si se proporciona y tiene un valor que se evalúa de manera booleana, verdaderamente dará como resultado la devolución de la lista de etiquetas separadas por comas por cada una de las ediciones.

Respuesta

Devolver la lista de ediciones de la revista dada.

Edición de Objetos
Valor Descripción
title Título de la edición
volume Volumen de la edición
ID ID de la edición
url URL de la edición
cover La URL de la portada en miniatura de la edición.
pages Número de páginas
tags La lista de etiquetas (palabras clave) de la edición están separadas por comas. Presentar sólo si la bandera "include_tags" es publicada
Ejemplo de respuesta:
        {
            "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"
                }]
            }
        }