Funktions Referenz

Funktions Referenz

Fehler werden im allgemeinen als SoapFault/Exception geworfen, so dass um jeden Aufruf ein entsprechender try AND catch Block gesetzt werden sollte. Der Fehler kann dann anhand Error-Message behandelt werden. Die Error-Message enspricht der Syntax '(ERRORCODE) ERRORMESSAGE'.

Ein Übersicht über die möglichen Fehlercodes sind im Kapitel Fehlercodes Übersicht (SoapFaults/Exceptions) zu finden.

Allgemein

getVersion

API Version abfragen

Return: string - api version

Parameter: -


PDF-Upload

PDF Upload über Formular

PDF-Dokumente können über POST unter folgender URL hochgeladen werden: http://epaper.1000grad.com/html/api/v2/pdf-upload

Return: string - JSON-Formatiertes Array

{
    'success': TRUE,
    'pdfId': 'PDF-ID'
}
oder
{
    'success': FALSE,
    'errors': {
        'clientCode': 'ERROR-Code',
        'errorDesc': 'Fehlermeldung'
    }
}

Parameter:

  • string $apikey - API Key
  • file $file - PDF-Dokument

Ein Beispiel wie Sie cURL implementieren finden Sie hier.

(php: cURL - Manual)

pdfUploadAsBase64

empfängt ein PDF Dokument als Base64 codierten String. Für die weitere Verarbeitung wird eine PDF ID zurückgegeben, welche für die Erstellung eines ePapers verwendet werden kann. Diese Funktion ist nur für PDF Dokumente bis 50 MB geeignet! Verwenden Sie stattdessen die Funktion PDF Upload über Formular!

Return: string - PDF ID

Parameter:

  • string $apikey - API Key
  • string $base64code - Base64 kodierte PDF-Datei (php: base64_encode)
Errors
2100 Pdf konnte nicht analysiert werden
2101 Pdf ist kein valides PDF Dokument
2102 Pdf enthält keine Seiten
2103 Pdf ist verschlüsselt und kann nicht verarbeitet werden
2104 Pdf enthält mehr Seiten als erlaubt

pdfInfos

Informationen zu einem PDF. Falls die pdfid nicht gefunden wird, wird ein leeres Array ausgegeben.

Return: string - JSON-Formatiertes Array

Parameter:

  • string $apikey - API Key
  • string $pdfid - PDF ID

 

Bereich ePaper

epaperCreateFromPdf

Erstellt ein ePaper aus der PDF ID von pdfUploadAsBase64. Die ePaper ID wird in weiteren Methoden benötigt. Damit ist das ePaper im System angelegt. Anschließend muss noch der Render-Prozess gestartet werden über epaperStartRenderprocess

Return: string - ePaper ID

Parameter:

  • string $apikey - API Key
  • string $pdfid - PDF ID aus der Funktion pdfUploadAsBase64

epaperStartRenderprocess

Startet den Renderprozess für ein ePaper.

Return: boolean

Parameter:

epaperUpdateFromPdf

Tauscht die PDF Datei eines existierenden ePaper gegen eine andere PDF Datei aus

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID
  • string $base64code pdf as base64 encoded string
  • integer $pageNum
  • boolean $replacePage
  • string $insertPosition
  • string json formatted

epaperGetInfos

Gibt Informationen zu einem ePaper als Json String zurück.

{
    'id': 'ID',
    'filename': 'Dateiname',
    'secure_filename': 'Dateiname mit sicheren Zeichen'
    'title': 'Titel'
    'pages': 'Seitenzahl'
    'zip_url': 'URL zur ZIP Datei, falls publiziert'
    'published': 'Publiziert ja/nein (0,1)'
    'status': 'Status Text',
    'renderprocess': {
        'status_text': 'Status Text',
        'current_page': 'Anzahl fertige Seiten',
        'percent': 'fertig in Prozent',
        'process_level': '0: Kein Prozess, 1: Renderprozess, 2: Publikationsprozess'
    },
    'settings': {
        //ePaper Einstellungen 'key': 'value'
    }
}

Weitere Informationen zum ePaper Status Text sind im Kapitel ePaper Status Übersicht zu finden.

Return: string JSON-Format

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID

epaperGetStatusString

Gibt den Statustext eines ePaper zurück.

Weitere Informationen zum ePaper Status Text sind im Kapitel ePaper Status Übersicht zu finden.

Return: string

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID

epaperDelete

Löscht ein ePaper

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID

epaperFindByPath

Ermittelt die ID eines ePaper anhand eines übergebenen Pfades. Wird kein ePaper ermittelt, wird ein leerer String zurückgegeben.

Return: string - ePaper ID

Parameter:

  • string $apikey - API Key
  • string $path - Pfad des ePaper, z.B.: ornder1/ordner2/epaper_dateiname

epaperSetIndexList

Legt eine ePaper Einstellung fest.

Weitere Informationen zu den Einstellungen sind im Kapitel ePaper Settings zu finden.

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID
  • integer $pageId - ID Page, entspricht im Normalfall der Seitennummer, sofern keine Seiten gelöscht oder hinzugefügt wurden. Seiten können über die Methode epaperGetPages abgefragt werden
  • array $options - enthält die Werte zum Setzen von Titel, Kurzbeschreibung, Autor, Einrückung und ob der Eintrag im Ihvz. aktiv ist

Information zu $options:

KeyValue
is_index boolean - [ 0 | 1 ] -> 1 aktiviert die Verwendung des Eintrags
index_indent integer - [ 0 | 1 | 2 | 3 ] - Level der Einrückung im Ihvz.
title string - Titel im Ihvz.
author string - Autor der Seite
description string - Kurzbeschreibung der Seite

epaperSetName

Legt den Namen eines ePapers fest.

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID
  • string $name - Name des ePapers

epaperSetVar

Legt eine ePaper Einstellung fest.

Weitere Informationen zu den Einstellungen sind im Kapitel ePaper Settings zu finden.

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID
  • string $key - Einstellungs Key
  • string $value - Wert

epaperSetVarImage

Setzt für die ePaper Einstellungen verschiedene Grafiken. Grafiken werden als String Parameter base64 kodiert übergeben.

Weitere Informationen zu den Einstellungen sind im Kapitel ePaper Settings zu finden.

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID
  • string $key - Erlaubte Werte: 'logo', 'background', 'background_left', 'background_right'
  • string $file - Pfad des Bildes, falls ein leerer String angegeben wird, wird das entsprechende Bild entfernt

epaperAddMediaToPage

Fügt Media Items einer Seite im ePaper hinzu.

Return: int - ID Media

Parameter:

  • string $apikey - API Key
  • string $epaperId - ID des epaper
  • integer $pageId - ID Page, entspricht im Normalfall der Seitennummer, sofern keine Seiten gelöscht oder hinzugefügt wurden. Seiten können über die Methode epaperGetPages abgefragt werden
  • string $type - Erlaubte Werte: 'link': Weblink, 'gallery': Bildergallerie(noch nicht implentiert), 'video': Video, 'linkintern': interner Link
  • string $data - siehe Information zu $data
  • array $options - siehe Information zu $options

Information zu $data:

Je nach $type übergebenen Werten, werden folgende Angaben erwartet:

$type$data
link string - URL des Weblinks
gallery (noch nicht implementiert) integer - Gallery ID
video string - URL des Video
linkintern integer - Page ID, Zielseite, entspricht im Normalfall der Seitennummer, sofern keine Seiten gelöscht oder hinzugefügt wurden. Seiten können über die Methode epaperGetPages abgefragt werden

Information zu $options:

KeyValue
title_short string - Kurzbezeichnung
title_long string - Beschreibung
width integer - Video Breite
height integer - Video Höhe
geo_rel string - Rahmen Koordinaten in der Form x1,y1,x2,y2. Koordinaten werden in Prozent angegeben, z.B. 0.24,0.31,0.66,0.73
frame_only integer - 1: Nur Rahmen verwenden
target string - Zielfenster für Weblinks, z.B. '_blank'
preview_image integer - 1 falls Bild verwendet werden soll
preview_image_base64 string - Base64 kodierte Bild Datei

epaperUpdateMediaItem

Updatet ein Media Item

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $epaperId - ID des epaper
  • integer $pageId - ID Page (siehe auch epaperGetPages)
  • integer $mediaId - ID Media (siehe auch epaperGetMediaItems)
  • string $type - Erlaubte Werte: 'link': Weblink, 'gallery': Bildergallerie(noch nicht implentiert), 'video': Video, 'linkintern': interner Link
  • string $data - siehe Information zu $data
  • array $options - siehe Information zu $options

Information zu $data:

Je nach $type übergebenen Werten, werden folgende Angaben erwartet:

$type$data
link string - URL des Weblinks
gallery (noch nicht implementiert) integer - Gallery ID
video string - URL des Video
linkintern integer - Page ID, Zielseite, entspricht im Normalfall der Seitennummer, sofern keine Seiten gelöscht oder hinzugefügt wurden. Seiten können über die Methode epaperGetPages abgefragt werden

Information zu $options:

KeyValue
title_short string - Kurzbezeichnung
title_long string - Beschreibung
width integer - Video Breite
height integer - Video Höhe
geo_rel string - Rahmen Koordinaten in der Form x1,y1,x2,y2. Koordinaten werden in Prozent angegeben, z.B. 0.24,0.31,0.66,0.73
frame_only integer - 1: Nur Rahmen verwenden
target string - Zielfenster für Weblinks, z.B. '_blank'
preview_image integer - 1 falls Bild verwendet werden soll
preview_image_base64 string - Base64 kodierte Bild Datei

epaperDeleteMediaItem

Löscht ein Media Item

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID
  • integer $pageId - ID Page (siehe auch epaperGetPages)
  • integer $mediaId - ID Media (siehe auch epaperGetMediaItems)

epaperSetDownloadOptionForPage

aktiviert/deaktiviert den Einzelseitendownload als PDF Datei

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID
  • integer $pageId - ID Page (siehe auch epaperGetPages)
  • boolean $value - TRUE aktiviert den Download

epaperGetPages

Gibt eine Liste aller im ePaper vorhandenen Seiten als Json Array zurück.

Return: string - JSON-Format

[{
    'id': '1', //integer - ID Page
    'page': '1', //integer - Page number
    'render_done': true, //boolean - page render complete 
    'render_error': false, //boolean - error occured on render process 
    'error_text': NULL, //string - error text 
    'error_swf': NULL, //string - error text 
    'pdf_width': '595', //integer - page width of pdf,
    'pdf_height': '842', //integer - page height of pdf 
    'swf_width' = > '565', //integer - page width after rendering
    'swf_height' = > '799', //integer - page height after rendering 
    'swf_quality' = > '1' //integer - quality identifier of rendered swf(1: best)
}, {
    'id': '2', //integer - ID Page
    'page': '2', //integer - Page number
    'render_done': true, //boolean - page render complete 
    'render_error': false, //boolean - error occured on render process 
    'error_text': NULL, //string - error text 
    'error_swf': NULL, //string - error text 
    'pdf_width': '595', //integer - page width of pdf,
    'pdf_height': '842', //integer - page height of pdf 
    'swf_width' = > '565', //integer - page width after rendering
    'swf_height' = > '799', //integer - page height after rendering 
    'swf_quality' = > '1' //integer - quality identifier of rendered swf(1: best)
}, {
    ...
}]

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID

epaperGetMediaItems

Gibt die komplette Liste mit den Media Items eines ePaper als Json String zurück

Return: string - JSON-Format

[{
    'id': '1',
    'id_page': '1',
    'sort_num': '1',
    'media_type' = > 'link',
    ...more...
}, {
    'id': '2',
    'id_page': '1',
    'sort_num': '2',
    'media_type' = > 'video',
    ...more...
}]

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaperID

epaperGetPath

Gibt den vollen Ordner Pfad eines ePaper als String zurück

Return: string - Pfad des ePapers, z.B.: /folder1/folder2/myepaper

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID

epaperMove

Verschiebt ein ePaper in einen Ordner

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID
  • string $targetPath - Zielpfad des ePaper inkl. Dateiname
  • boolean $overwrite - Überschreibt ein ePaper falls ePaper mit Dateinamen bereits vorhanden ist

Achtung: Bei der Verwendung der REST API kann für $overwrite nur 0 als Wert für false übergeben werden. Alle anderen Werte (true, false, 1, etc..) werden als String und damit als true interpretiert.

epaperGetList

Gibt eine Liste von ePapern anhand des Verzeichnisses als Json String zurück

Return: string - JSON-Format

[{
    'id': '4f965147a414c',
    'status': 'ready',
    'filename': 'myepaper1',
    'pages': 12
}, {
    'id': '4f9655b8828a5',
    'status': 'ready',
    'filename': 'myepaper2',
    'pages': 24
}]

Parameter:

  • string $apikey - API Key
  • string $folder - Name/Pfad des Ordners

epaperPublish

Publiziert ein ePaper.

Achtung: Fehler 1101 wird geworfen, fall nicht genügend Lizensen vorhanden sind.

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID

epaperFtpTransfer

Überträgt ein ePaper auf einen FTP Server, falls die FTP Zugangsdaten im Ordner angegeben sind.

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID

epaperGetZip

Gibt die URL der Zip zurück, falls ZIP nicht vorhanden, wird ein Fehler 1301 geworfen.

Return: string - URL

Parameter:

  • string $apikey - API Key
  • string $epaperId - ePaper ID

epaperImportFromExportFile

Importiert eine ePaper Exportdatei

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $epaperId - ID des ePaper
  • string $base64code - Base64 kodierte ePaper Export Datei
  • boolean $importPages - Importieren der Seiteninformationen, wie Titel, Beschreibung, Autor
  • boolean $importSettings - Importieren der ePaper Einstellungen
  • boolean $importMedia - Importieren der Media Items
  • boolean $deleteMedia - bereits vorhandene Media Items überschreiben
  • boolean $importGalleries - Importieren der Galerien
  • boolean $deleteGalleries - bereits vorhandene Galerien überschreiben

 

Bereich Ordner

foldersGetTree

Gibt die komplette Baumstruktur eines Accounts als Json String zurück

Return: string - JSON-Format

[{
    'level': '1',
    'name': 'folder1',
    'children': [{
        'level': '2',
        'name': 'subfolder1',
        'children': []
    }, {
        'level': '2',
        'name': 'subfolder2',
        'children': []
    }, ...]
}, {
    'level': '1',
    'name': 'folder2',
    'children': []
}, ...]

Parameter:

  • string $apikey - API Key

 

Errors
5100 Es stehen keine Kanäle mehr zur Verfügung
5404 Kanal konnte nicht gefunden werden
5503 Kanal wird gerade bearbeitet und kann nicht modifiziert werden

channelsGetList

Gibt eine Liste der verfügbaren Kanäle als Json String zurück

Return: string - JSON-Format

Parameter:

  • string $apikey - API Key

channelsGetChannelInfo

Gibt die Informationen für einen besitmmten Kanal zurück

Return: string - JSON-Format

Parameter:

  • string $apikey - API Key
  • string $channelId - ID des Kanals

channelsPublishEpaperToChannel

Publiziert ein ePaper in einen Kanal

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $epaperId - ID des ePapers
  • string $channelId - ID des Kanals

channelsRemoveEpaperFromChannel

Entfernt ein vorhandenes ePaper aus einem Kanal

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $channelId - ID des Kanals

channelsSetChannelTitle

Setzt den Titel eines Kanals

Return: boolean

Parameter:

  • string $apikey - API Key
  • string $channelId - ID des Kanals
  • string $title

    • Related Articles

    • Einleitung - Erste Schritte

      Einleitung Auf einen ePaper-Account kann per API zugegriffen werden. Diese Schnittstelle ermöglicht es komfortabel ePaper hochzuladen, zu rendern und zu publizieren. Dazu wird ein API-Key benötigt. Diese Dokumentation soll einen Einstieg in die ...

    • Fehlercodes Übersicht (SoapFaults/Exceptions)

      Allgemein 400 not implemented 401 access denied, apikey is not correct 403 forbidden 404 data not found 500 internal server error, no specified error from api 600 invalid parameters ePaper 1100 epaper not ready 1101 not enough transactions to publish ...

    • Die Links und Schaltflächen im Seitenkopf

      Im oberen Bereich des ePaper CMS finden Sie weitere Links und Schaltflächen, über die Sie Ihr Konto verwalten, Informationen einsehen, oder Hilfestellungen nutzen können.   “Benutzerprofil”: Anhand des Benutzernamens in dieser Schaltfläche sehen Sie, ...

    • ePaper auf einer Webseite einbinden

      Teil 1 Unsere ePaper lassen sich einfach und in wenigen Schritten auf einer Webseite einbinden. Im ersten Teil dieses Tutorials erfahren Sie kurz und bündig was Sie dafür tun müssen. Wenn Sie Ihre ePaper über einen Weblink bei uns veröffentlichen, ...

    • ePaper auf einer Webseite einbinden

      Kontrollieren Sie Ihr ePaper vor dem Download Das Zip–Paket herunterladen und entpacken Die Ordnerstruktur unserer ePaper Das ePaper auf einen Server laden Das ePaper im HTML Code einer Webseite einbetten Teil 1 Unsere ePaper lassen sich einfach und ...