Joomag provides an API, which can be used to manage Joomag account by 3rd party applications. For instance, it may be used for creating magazines from PDF files.
The API is based on HTTP protocol with JSON responses.
All the requests should be submitted using HTML POST to the following URL:
http://www.joomag.com/Frontend/WebService/restAPI.php
PHP API client class can be downloaded from here.
All the requests should be submitted using HTML POST to the following URL:
http://www.joomag.com/Frontend/WebService/restAPI.php
PHP API client class can be downloaded from here.
Creating magazines from PDF
Create a new publication on Joomag from a PDF file.Parameters
| Parameter | Required | Description |
|---|---|---|
| key | Yes | API Key of your account. You may get it from My Account > Settings. |
| action | Yes | Should be createMagazineFromPDF |
| Yes | PDF file posted with “multipart/form-data” encoding | |
| magazine_ID | Yes | Unique ID of the magazine where you wish to create the issue. This can be retrieved from here. |
| volume | Yes | The volume of the newly created issue |
| description | No | The description of the newly created issue. |
| keywords | No | Comma separated list of keywords |
| allow_print | No | Flag, indicating whether the issue is allowed for printing or not. Can be either 1 or 0. (Default 0). |
Response
Returns the temporary ID of the newly created issue. It can be later used for retrieving the status of conversion.Sample response:
{
"error" : 0,
"msg" : "",
"response" : {
"issueTempID" : "6d8b27d868843a6ebaa8a5f44d7accb8"
}
}
Checking PDF status
Get the status of the PDF file.Parameters
| Parameter | Required | Description |
|---|---|---|
| key | Yes | API Key of your account. You may get it from My Account > Settings. |
| action | Yes | Should be checkPDFStatus |
| tempID | Yes | issueTempID from responce of createMagazineFromPDF request |
Response
Returns the status of the PDF file. If the PDF is ready, the URL and ID is returned.Statuses
| Value | Description |
|---|---|
| ready | The PDF conversion completed successfully and the issue is ready for viewing. |
| error | Error occurred while converting the PDF file |
| pending | The PDF conversion is in the process |
Sample response:
{
"error" : 0,
"msg" : "",
"response" : {
"status" : "ready",
"code" : "2",
"url" : "http:\/\/www.joomag.com\/magazine\/mag\/0379014001353947680",
"issue_ID" : "0379014001353947680"
}
}
Get the list of Issues
Retrieve the list of issues in the specified magazine.Parameters
| Parameter | Required | Description |
|---|---|---|
| key | Yes | API Key of your account. You may get it from My Account > Settings. |
| action | Yes | Should be listIssues |
| magazine_ID | Yes | Unique ID of the magazine where you wish to create the issue. This can be retrieved from here. |
Response
Returns the list of issues of the given magazine.Issue Object
| Value | Description |
|---|---|
| title | Title of the issue |
| ID | ID of the issue |
| url | URL of the issue |
| pages | Number of pages |
Sample response:
{
"error" : 0,
"msg" : "",
"response" : {
"issues" : [{
"title" : "Healty Live Vol. 1",
"ID" : "0379014001353530983",
"url" : "http:\/\/www.joomag.com\/magazine\/healty-live-vol-1\/0379014001353530983",
"pages" : 24
}, {
"title" : "Healty Live Vol. 2",
"ID" : "0812158001353446983",
"url" : "http:\/\/www.joomag.com\/magazine\/healty-live-vol-2\/0812158001353446983",
"pages" : 28
}, {
"title" : "Healty Live Vol. 3",
"ID" : "0453041001369593634",
"url" : "http:\/\/www.joomag.com\/magazine\/healty-live-vol-3\/0453041001369593634",
"pages" : 30
}]
}
}
