Joomag API 2.0 Dokumentation

Ausgaben

Ausgabe aus PDF erstellen

Erstellt eine Ausgabe des Magazins aus einer PDF-Datei.

POST /api/2.0/magazines/<id>
Parameter Typ Erklärung
pdf Datei PDF-Datei um daraus eine Ausgabe eines Magazins zu erstellen
volume string Titel der neuen Ausgabe
description string Die Beschreibung der neuen Ausgabe
keywords string Durch Kommas getrennte Liste der Schlüsselwörter, die mit dieser Ausgabe assoziiert werden.
category int Kategorie der Ausgabe, eine Konstante der Magazine Categories List
allow_print bool Boolean Flag um anzugeben ob die Ausgabe ausdruckbar sein soll oder nicht, der Wert muss entweder no oder yes sein.
allow_download bool Boolean Flag um anzugeben ob die Ausgabe downloadbar sein soll oder nicht, der Wert muss entweder no oder yes sein.
privacy string Das Privatsphäre-Level der Ausgabe kann private oderunlisted sein.

Beispiel:

# Include the API wrapper class
require "JoomagREST.php";

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# ID of the magazine
$magazineID = "M0250759001409245540";

# Path to the PDF file
$pdf = __DIR__ . "/magazine.pdf";

# Make the call to the client.
$result = $jmClient->createIssueFromPDF( $magazineID, $pdf, array(
    "volume" => "Jul 2014",
    "description" => "Magazine description goes here...",
    "keywords" => "Comma,separated,keywords",
    "category" => 1,
    "allow_print" => 'yes',
    "allow_download" => 'no'
));

Antwort:

issueTempID ist eine vorübergehende ID während die PDF zur Joomag-Ausgabe konvertiert wird

{
  "error": 0,
  "message": "OK",
  "data": {
    "issueTempID": "1d6bb45be5cf7e3778985467bea009c4"
  }
}

Konvertierungs-Status der Ausgabe abfragen.

Teilt den aktuellen Stand der Konvertierung von PDF zur Joomag-Ausgabe mit.

GET /api/2.0/magazines/<id>/issues/<issueTempID>/status
GET /api/2.0/issues/<issueTempID>/status
Parameter Typ Erklärung
issueTempID string Dies ist eine vorübergehende ID während die PDF zur Joomag-Ausgabe konvertiert wird. Benutzen Sie die issueTempID der createIssuePDF Antwort.

Beispiel:

# Include the API wrapper class (see "Libraries" for instructions)
require 'JoomagREST.php';

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# Make the call to the client.
$result = $jmClient->getIssueStatus( $issueTempID );

Antwort:

{
  "error": 0,
  "message": "OK",
  "data": [
    {
      "status": "ready",
      "ID": "0806746001433247707",
      "url": "http://www.joomag.com/magazine/mag/0806746001433247707",
      "cover": "https://s1.joomag.net/res_mag/3/3222/3222314/287017/thumbs/6637753.jpg?1433247710",
      "pages_count": 2
    }
  ]
}

Ausgaben-Details abrufen

Teilt Eigenschaften der angefragten Ausgabe mit

GET /api/2.0/magazines/<id>/issues/<id>
GET /api/2.0/issues/<id>

Beispiel:

# Include the API wrapper class (see "Libraries" for instructions)
require 'JoomagREST.php';

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# ID of the issue
$issueID = "0980693001409324380";

# Make the call to the client.
$result = $jmClient->getIssueDetails( $issueID );

Antwort:

{
  "error": 0,
  "message": "OK",
  "data": {
    "ID": "0980693001409324380",
    "title": "Cars Magazine Pro Jul 2014",
    "volume": "Jul 2014",
    "description": "Magazine description goes here...",
    "language": "es",
    "type": 1,
    "category": 8,
    "secondary_category": null,
    "is_published": true,
    "privacy": "private",
    "creation_date": "2014-08-29 09:59:40",
    "page_height": 841,
    "page_width": 595,
    "preview_pages": null,
    "adult_content": false,
    "pages_count": 6,
    "cover": "http:\/\/s1.joomag.com\/res_mag\/0\/178\/178119\/316952\/thumbs\/7463808.jpg",
    "mobile_support": true,
    "allow_download": false,
    "allow_print": false,
    "tags": ["keywords", "comma", "separated"]
  }
}

Einbettungscode anfordern

Bezieht den HTML-Einbettungscode des angeforderten Magazins.

GET /api/2.0/magazines/<id>/issues/<id>/embed-code
POST /api/2.0/issues/<id>/embed-code
Parameter Typ Erklärung
width int Breite der Einbettung. Kann entweder in Prozent (z.B. 100%) oder in Pixel (z.B. 500px) angegeben sein.
height int Höhe der Einbettung. Kann entweder in Prozent (z.B. 100%) oder in Pixel (z.B. 500px) angegeben sein.
start_page int Seitenzahl der Seite, auf der sich das Eingebettete Magazin öffnen soll.
auto_flip int Anzeigedauer der Seiten beim automatischen Blättern. Leer lassen um automatisches Blättern auszuschalten.
background_color string Hintergrundfarbe oder Einbettung. Hexadezimaler RGB-Code der Farbe (z.B. e2e2d1)

Beispiel:

# Include the API wrapper class (see "Libraries" for instructions)
require 'JoomagREST.php';

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# ID of the issue
$issueID = "0980693001409324380";

# Make the call to the client.
$result = $jmClient->get("issues/$issueID/embed-code", array(
    'width' => 800,
    'height' => 600,
    'start_page' => 2,
    'auto_flip' => 5,
    'background_color' => '567147'
));

Antwort:

{
  "error": 0,
  "message": "OK",
  "data": {
    "embed_code": "<iframe name=\"Joomag_embed_47ccbf7a-6e78-4755-9920-53d568472b51\" style=\"width:800px;height:600px\" width=\"800px\" height=\"600px\" hspace=\"0\" vspace=\"0\" frameborder=\"0\" src=\"http:\/\/www.joomag.com\/magazine\/paid-test-clone-\/0827766001386622771?p=2&amp;e=1&amp;autoFlipDelay=5&amp;embedInfo=;solid,567147\"><\/iframe>"
  }
}

Ausgabe löschen

Löscht die angeforderte Ausgabe

DELETE /api/2.0/magazines/<id>/issues/<id>
DELETE /api/2.0/issues/<id>

Beispiel:

# Include the API wrapper class (see "Libraries" for instructions)
require 'JoomagREST.php';

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# ID of the issue
$issueID = "0727865001409319307";

# Make the call to the client.
$result = $jmClient->deleteIssue( $issueID );

Antwort:

{
  "error": 0,
  "message": "OK",
  "data": []
}

Aktualisiert Ausgabeninformationen

Aktualisiert die Eigenschaften der angeforderten Ausgabe.

PUT /api/2.0/magazines/<id>/issues/<id>
PUT /api/2.0/issues/<id>
Parameter Typ Erklärung
volume string Titel der Ausgabe
description string Beschreibung der Ausgabe
secondary_category int Sekundäre Kategorie der Ausgabe, eine Konstante der Magazine Categories List
adult_content bool Boolean Flag um anzugeben ob die Ausgabe Erwachseneninhalte enthält, der Wert muss entweder no oder yes sein.
allow_print bool
allow_download bool

Beispiel:

# Include the API wrapper class (see "Libraries" for instructions)
require 'JoomagREST.php';

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# ID of the issue
$issueID = "0980693001409324380";

# Make the call to the client.
$result = $jmClient->updateIssue( $issueID, array(
    'volume' => 'Aug 2014',
    'description' => 'The newest issue',
    'adult_content' => 'yes',
    'allow_print' => 'yes',
    'allow_download' => 'yes'
));

Antwort:

{
  "error": 0,
  "message": "OK",
  "data": {
    "ID": "0980693001409324380",
    "title": "Cars Magazine Pro Jul 2014",
    "volume": "Aug 2014",
    "description": "The newest issue",
    "language": "es",
    "type": 1,
    "category": 8,
    "secondary_category": null,
    "price": 0,
    "privacy": "unlisted",
    "creation_date": "2014-08-29 09:59:40",
    "page_height": 841,
    "page_width": 595,
    "preview_pages": null,
    "adult_content": true,
    "pages_count": 6,
    "cover": "http:\/\/s1.joomag.com\/res_mag\/0\/178\/178119\/316952\/thumbs\/7463808.jpg",
    "mobile_support": true,
    "allow_download": true,
    "allow_print": true,
    "tags": ["keywords", "comma", "separated"]
  }
}

Ausgabe veröffentlichen

Veröffentlicht das angeforderte Magazin.

PUT /api/2.0/issues/<id>/publish-state
Parameter Typ Erklärung
privacy string Das Privatsphäre-Level der Ausgabe kann private oderunlisted sein.

Beispiel:

# Include the API wrapper class (see "Libraries" for instructions)
require 'JoomagREST.php';

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# ID of the issue
$issueID = "0649338001409248394";

# Make the call to the client.
$result = $jmClient->publishIssue( $issueID, 'unlisted' );

Antwort:

{
  "error": 0,
  "message": "OK",
  "data": []
}

Veröffentlichung rückgängig machen

Macht die Veröffentlichung des angeforderten Magazins rückgängig.

DELETE /api/2.0/issues/<id>/publish-state

Beispiel:

# Include the API wrapper class (see "Libraries" for instructions)
require 'JoomagREST.php';

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# ID of the issue
$issueID = "0727865001409319307";

# Make the call to the client.
$result = $jmClient->unpublishIssue( $issueID );

Antwort:

{
  "error": 0,
  "message": "OK",
  "data": []
}

Veröffentlichungs-Status überprüfen

Überprüft ob die Ausgabe veröffentlicht ist oder nicht.

GET /api/2.0/issues/<id>/publish-state

Beispiel:

# Include the API wrapper class (see "Libraries" for instructions)
require 'JoomagREST.php';

# Instantiate the client.
$jmClient = new JoomagREST(
    'api_de81b9eb3ff797796edc0cd00020b6c8',
    'sec_e8ff4e7e74c64fcfd63dcf728040ba3e5b29aa398e5cc1cb414011661c75fd19'
);

# ID of the issue
$issueID = "0727865001409319307";

# Make the call to the client.
$result = $jmClient->getIssuePublishState( $issueID );

Antwort:

{
  "error": 0,
  "message": "OK",
  "data": {
    "is_published": true
  }
}