Manual API Joomag

Joomag oferece uma API que pode ser usada para gerenciar a conta Joomag por aplicativos de terceiros. Por exemplo, ela pode ser usada para criar revistas a partir de arquivos PDF. A API é baseada no protocolo HTTP com respostas JSON.

Todas as solicitações devem ser encaminhadas usando HTML POST para a seguinte URL:
http://www.joomag.com/Frontend/WebService/restAPI.php

A classe do cliente PHP API pode ser baixada em Cliente PHP API.

Criando revistas a partir do PDF

Criar uma nova publicação na Joomag a partir de um arquivo PDF.

Parâmetros

Parâmetro Necessário Descrição
key Chave API da sua conta. Você pode obtê-la em Minha Conta > Configurações.
action Deve ser checkPDFStatus
pdf Arquivo PDF publicado com a codificação “multipart/form-data”
magazine_ID ID único da revista onde deseja criar a edição. Este pode ser recuperado aqui.
volume O volume da edição recém criada
description A descrição da edição recém criada
keywords A lista de palavras chave é separada por vírgulas
allow_print Bandeira, indicando se é permitido a impressão da edição ou não. Pode ser 1 ou 0. (Padrão é 0).

Resposta

Devolve o ID temporário da edição recém criada. Pode ser usado mais tarde para recuperar o estado da conversão.

Exemplo de resposta:
        {
            "error" : 0,
            "msg" : "",
            "response" : {
                "issueTempID" : "6d8b27d868843a6ebaa8a5f44d7accb8"
            }
        }
            

Verificando estado do PDF

Obter estado do arquivo PDF.

Parâmetros

Parâmetro Necessário Descrição
key Chave API da sua conta. Você pode obtê-la em Minha Conta > Configurações.
action Deve ser checkPDFStatus

Resposta

Devolve o estado do arquivo PDF. Se o PDF estiver pronto, a URL e o ID são devolvidos.

Estados
Valor Descrição
ready A conversão do PDF foi concluída com sucesso e a edição está pronta para visualização.
error Ocorreu um erro na conversão do arquivo PDF
pending A conversão do PDF está em processo
Exemplo de resposta:
        {
            "error" : 0,
            "msg" : "",
            "response" : {
                "status" : "ready",
                "code" : "2",
                "url" : "http:\/\/www.joomag.com\/magazine\/mag\/0379014001353947680",
                "issue_ID" : "0379014001353947680"
            }
        }
            

Obter a lista de Revistas

Recuperar a lista de todas as Revistas em sua conta.

Parâmetros

Parâmetro Necessário Descrição
key Chave API da sua conta. Você pode obtê-la em Minha Conta > Configurações.
action Deve ser listMagazines

Resposta

Devolve a lista de Revistas na sua conta.

Objeto da Revista
Valor Descrição
title Título da Revista
ID ID da Revista
url URL da Revista. Conterá a última edição publicada
Exemplo de resposta:
        {
            "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",
                }]
            }
        }
            

Obter lista de Edições

Recuperar a lista de edições na revista específica.

Parâmetros

Parâmetro Necessário Descrição
key Chave API da sua conta. Você pode obtê-la em Minha Conta > Configurações.
action Deve ser listIssues
magazine_ID ID único da revista onde deseja criar a edição. Este pode ser recuperado aqui.
include_tags Se fornecido e tem um valor que se avalia como boolean true resultará em devolver a lista de etiquetas separada por vírgula para cada edição.

Resposta

Devolve a lista de edições da determinada revista.

Objeto da Edição
Valor Descrição
title Título da edição
volume Volume da edição
ID ID da edição
url URL da edição
cover URL da imagem em miniatura da capa da edição
pages Número de páginas
tags Lista de etiquetas (palavras chave) separada por vírgula da edição. Presente apenas se "include_tags" for postado.
Exemplo de resposta:
        {
            "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"
                }]
            }
        }