PHP Adapter

Konfiguration und Installation

  1. Laden sie den php_adapter hier herunter
  2. Ändern sie das pdfnow.php Skript, fügen Sie ihren API Schlüssel hinzu und kopieren sie die Datei in ihr PHP Modul Verzeichnis
    	define('APIKEY', '123');
  3. Binden Sie die Pdfnow Bibliothek in ihr PHP-Modul mit ein:
    	require_once('pdfnow.php');
  4. Fügen sie den Generator-Aufruf in ihren Quellcode mit ein
    	generatePdf('uploadedTemplate', array('doc' => array(
    'type' => 'letter',
    'subject' => 'An Order from July 2014',
    'recipient' => array(
    'field1' => 'A. Customer',
    'field2' => 'Destinationstreet 999',
    'field3' => '1000 Destinationcity',
    'field4' => 'SomeCountry'
    ),
    'text' => 'Dear customer,
    thank\'s for your order.
    Greetings from here!

    A. Company'
    );

Verwendung

Die Signatur der pfnow php API:

	generatePdf(  String templateName, Array data ) : String

Der Template-Name verweist auf das bereits von Ihnen hochgeladene Template.

Das data XML beinhaltet die nötigen Daten, welche in das Template eingefügt werden sollen. Die Struktur der Daten wird bereits durch das Template vorgegeben. Das Array wird in einen entsprechenden XML-String konvertiert.

 

Als Ergebnis wird eines der beiden Resultate zurückgeliefert:

  • die URL von dem erzeugten PDF
  • eine Fehler-Nachricht, in dem Fall beginnt die Zeichenkette mit "NOK"

Bitte beachten Sie: die URL von dem generierten PDF ist nur für ein paar Minuten Gültig. Falls sie dieses länger verfügbar haben möchten, müssen Sie es auf ihren Server kopieren.

 

Webservice

Um unseren Webservice nutzen zu können, müssen Sie ein registrierter Nutzer sein.

Nach dem Sie auf den Navigationspunkt "Nutzerbereich" geklickt haben, werden sie den API-Key sehen. Dieser Schlüssel wird für den PHP-Adapter benötigt. Es gibt drei verschiedene Bereiche:

  • Vorlagen anzeigen
  • Vorlagen hochladen
  • Pdf generieren

Der erste Schritt ist es ein Template hochzuladen. Es ist dabei nötig einen Template-Namen mit anzugeben, der für die Generierung eines Pdfs angegeben werden muss. Das zweite Feld wird genutzt, um das Template von der lokalen Platte hochzuladen. Bitte nutzen Sie entweder eine einfache Template-Vorlage (XML-Datei im korrekten FO-Format). Alternativ ist es möglich, ein ZIP-Archiv upzuloaden, welches eine Datei enthält, die zwingend "template.xml" benannt ist. Dieses Zip-Archiv kann andere Ressourcen-Dateien, wie Bilder ebenfalls enthalten.

Ein Pdf zu erstellen kann mit dem Php-Adapter oder über die Weboberfläche erfolgen. Hier geben Sie ihren Template-Namen und die XML-Daten für das Template mit an. Bitte stellen Sie sicher, dass ihre XML-Daten im korrekten Format sind und zu ihrer gewählten Vorlage passen. Nach dem Generierungsprozess ist es möglich das fertig erstellte PDF herunterzuladen.

Um die Vorlagen zu verwalten, umzubennen, oder zu löschen, ist die Vorlage-anzeigen Seite die richtige. Alle Aktionen werden direkt ausgeführt.