Joomag API инструкция

Joomag обеспечивает API для управления аккаунтом Joomag через приложения 3-х компаний. Например, может быть использовано для создания журналов из PDF файлов. API базируется на HTTP протоколе с JSON ответами.

Все запросы должны быть представлены с использованием HTML POST по следующему адресу URL:
http://www.joomag.com/Frontend/WebService/restAPI.php

PHP API клиент класс можно скачать из PHP API Клиент.

Создать журнaл из PDF

Создайте новую публикацию из PDF файла.

Параметры

Параметр Требуется Описание
key API Ключ Вашего аккаунта. Вы можете получить его из Мой аккаунт> Настройки.
action Должно быть checkPDFStatus
pdf PDF файл размещен с “multipart/form-data” кодом
magazine_ID Уникальный ID журнала, где вы хотите создать публикацию. Его можно получить здесь.
volume Том вновь созданного выпуска
description Описание нового выпуска
keywords Список ключевых слов через запятую
allow_print Индикатор, указывающий на возможность печати издания. Может быть либо 1, либо 0. (По умолчанию 0).

Ответ

Возвращает временный ID нового выпуска. Он может быть использован впоследствии для восстановления статуса конвертации.

Образец ответа:
        {
            "error" : 0,
            "msg" : "",
            "response" : {
                "issueTempID" : "6d8b27d868843a6ebaa8a5f44d7accb8"
            }
        }
            

Статус PDF проверяется

Получить статус PDF файла

Параметры

Параметр Требуется Описание
key API Ключ Вашего аккаунта. Вы можете получить его из Мой аккаунт> Настройки.
action Должно быть checkPDFStatus

Ответ

Возвращает статус файла PDF. Если PDF готов, URL и ID возвращаются.

Статусы
Значение Описание
ready Конвертация PDF успешно завершена. Публикация готова к просмотру.
error Произошла ошибка при конвертации файла PDF
pending Идет процесс конвертация PDF
Образец ответа:
        {
            "error" : 0,
            "msg" : "",
            "response" : {
                "status" : "ready",
                "code" : "2",
                "url" : "http:\/\/www.joomag.com\/magazine\/mag\/0379014001353947680",
                "issue_ID" : "0379014001353947680"
            }
        }
            

Получить список журналов

Получить список всех журналов вашего аккаунта.

Параметры

Параметр Требуется Описание
key API Ключ Вашего аккаунта. Вы можете получить его из Мой аккаунт> Настройки.
action Должно быть {0}listMagazines{1}

Ответ

Возвращает список журналов вашего аккаунта.

Объект журнала
Значение Описание
title Заголовок журанала
ID ID журнала
url URL журнала. Будет содержать последний опубликованный выпуск.
Образец ответа:
        {
            "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",
                }]
            }
        }
            

Получить список выпусков

Получить список выпусков определенного журнала.

Параметры

Параметр Требуется Описание
key API Ключ Вашего аккаунта. Вы можете получить его из Мой аккаунт> Настройки.
action Должно быть {0}listIssues{1}
magazine_ID Уникальный ID журнала, где вы хотите создать публикацию. Его можно получить здесь.
include_tags При наличии значения, которое определяется как истина, в результате получается список через запятую тэгов для каждого выпуска.

Ответ

Возвращает список выпусков указанного журнала.

Объект выпуска
Значение Описание
title Заголовок издания
volume Том издания
ID ID издания
url URL издания
cover Адрес URL миниатюры обложки издания
pages Количество страниц
tags Список тэгов (ключевых слов) издания через запятую. Возможен, только если включен индикатор "включить тэги"
Образец ответа:
        {
            "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"
                }]
            }
        }