Zur Übersicht

So machst du mit Joomag aus simplen PDFs clevere e-Publikationen

Aktualisiert am 17. Aug. 2020
MASSIVE-ART-Joomag

Blätterbare E-Publikationen können sinnvoll für Werbe- und Marketingmaßnahmen von Unternehmen eingesetzt werden. Dabei werden Informationen wie PDF-Dokumente auf eine interaktive Art und Weise bereitgestellt. Wir haben uns dies zunutze gemacht und das Downloadcenter von Hoval mit dem digitalen Publishing Service Joomag verknüpft.

Es gibt mittlerweile eine Fülle an Digital Publishing Services, eines der wohl bekanntesten ist Issuu. Bei der Auswahl lag unser Hauptaugenmerk auf der API (Application Programming Interface), da wir den Service von ZOOLU aus ansprechen wollten. Joomag bietet mit der sauberen und ausführlich dokumentierten Schnittstelle genau das, was uns für die ZOOLU Integration wichtig war.

Wie funktioniert Joomag?

Der zu veröffentlichende Inhalt kann entweder per PDF bereitgestellt, oder im Joomag Webeditor selbst erzeugt werden. Daraus wird ein blätterbares E-Magazin generiert – interaktiv aufbereitbar mittels Video, Audio oder Animationen.

Die fertige Publikation kann man anschließend im Web veröffentlichen und ist auf allen Devices zugänglich. Für den Desktop wird die Publikation als Flash-Variante und auf Mobile Devices als HTML5-Variante zur Verfügung gestellt. Nun kann die Publikation auf Webseiten, Social Media Plattformen oder über eine eigene Joomag URL bereitgestellt werden.

Der Vorteil für Hoval

Im Hoval Downloadcenter findet der Benutzer eine Fülle an digitalen Prospekten und Broschüren zu den Produkten. Mithilfe von Joomag ist es nun möglich, die Dokumente im Downloadcenter als interaktives Magazin im Browser bereitzustellen – alternativ zum Download. Mit nur einem Klick werden die Werbemittel anschaulich und spannend präsentiert. Und der Benutzer kann sich entspannt durch die Produktwelt von Hoval klicken.

MASSIVE-ART-Blog-Hoval_Joomag
MASSIVE-ART-Blog-Hoval_Joomag

Joomag meets ZOOLU

Mit einer Checkbox in ZOOLU können nun also neue und bereits bestehende PDF-Dokumente bei der Pflege als blätterbare E-Magazin-Variante bereitgestellt werden. In weiterer Folge übermittelt ZOOLU das Dokument an die Joomag Schnittstelle, um die PDFs zu konvertieren. Wie bereits angesprochen, stellt Joomag eine sehr simpel aufgebaute API bereit. Hier findet ihr die Dokumentation dazu: joomag.com/en/api

Jetzt wird’s technisch

Ich werde nun ins Detail gehen und das automatisierte Rendern von PDF’s per Joomag API Schritt für Schritt beschreiben.

Um PDF’s automatisiert rendern zu lassen, stellt Joomag die Methode “createFromPDF()” bereit. Doch bevor wir diese verwenden können, erzeugen wir eine neues JoomagAPIClient-Objekt.

// Instanzierung eines JoomagAPIClient-Objektes

$api = new JoomagApiClient($key);

Anschließend kann unsere Methode aufgerufen werden. Zum Pfad des Dokuments wird nun eine Magazin-ID als Parameter mitgegeben – eine eindeutige ID, die auf ein zuvor im Admin Bereich erstelltes Joomag Magazin zeigt. Ein Magazin ist eine Sammlung von Dokumenten oder Ausgaben (Issues).

// Aufruf der Konvertierungs- Methode

$res = $api->createFromPDF($file, $magazineID, $volume);

Jedes Dokument im Hoval Downloadcenter stellt ein eigenständiges Issue dar und wird unter demselben Magazin zusammengefasst. Ein weiterer zwingender Parameter ist das Volumen – also der Name des Dokuments.

Nun beginnen wir mit dem Konvertieren unserer PDF mittels dem Service von Joomag. Im nächsten Schritt überprüfen wir in einem bestimmten Zeitintervall den Status des Vorgangs. Dafür wenden wir die "checkPDFStatus"-Methode an.

// Intervallmäßige Überprüfung des Konvertierungs- Status
do {
   sleep(5);
   $res = $api->checkPDFStatus($tempID);
   $response = $res->response();
} while ($response['status'] == 'pending');

Ist nun das Dokument fertig konvertiert, erhalten wir als Antwort ein Response Objekt. Dieses enthält die Issue ID des erstellten Joomag Magazin - "$response['issue_ID']". Diese ID wird bei uns in der Datenbank abgelegt.

// Speichern der Issue ID

if ($response['status'] == 'ready') {
   // write IssueID to DB
   $objFile = $objModelFiles->updateIssueId($idFiles, $response['issue_ID']);
}

Ist nun zu einem Dokument eine Issue ID hinterlegt, so wird im Downloadcenter neben dem “Download”-Link auch ein “PDF Anzeigen”-Link angezeigt. Beim Klick wird eine Methode aufgerufen, die uns die Joomag-URL zu der angeforderten Issue ID bereitstellt. Und das funktioniert folgendermassen.

Joomag-URL zur angeforderten Issue-ID bereitstellen

Nach der erneuten Instanziierung des JoomagAPIClient können wir mit der MethodelistIssues()” uns alle konvertierten Dokumente zu unserem Magazin zurückgeben lassen.

// Array aller Dokumente des Magazines

$res = $api->listIssues($magazineID); 
$response = $res->response(); 
$issues = ($response['issues']);

Nun gehen wir alle Dokumente in einer Schleife durch und holen uns die URL des angeforderten Dokuments. In unserem Beispiel enthält die Variable "requestedID" enthält die Issue ID des angeforderten Dokuments aus dem Downloadcenter.

foreach ($issues as $issue){ 
   // Zurückgeben der angeforderten URL
   if ($requestedID == $issue->ID) { 
   $url= $issue->url . '?preview'; 
   break;
   } 
}

In der Variable "$url" befindet sich nun unserer Joomag-URL zum angeforderten Dokument. Der Benutzer wird nun im nächsten Schrift auf diese URL weitergeleitet und es wird die blätterbare e-Magazin Variante des PDF’s angezeigt.

Mein Fazit

Mit der Integration von Joomag in das Hoval- Downloadcenter wurde ein Feature integriert, dass einen klaren Mehrwert für Hoval und seine Kunden bietet. Neben dem gewöhnlichen Download können nun Dokumente auf eine interaktive und spannendere Art und Weise betrachtet werden.