Formular-API

Inhaltsverzeichnis

Die mittels des Formular-Template gebauten Mini-Applikationen enthalten von vorneherein REST-APIs.

Schreib-API

Da Sie als Redakteur die Formulare definieren werden, ist eine allgemeine Schnittstellenbeschreibung nicht möglich.

Zum automatisierten Schreiben via Formulare wird einfach die jeweilige Formularseite verwendet. Sie senden dabei einen POST-Request an die betreffende URL.

Überprüfen Sie vorher im HTML-Quellcode der Seite die durch den Imperia-Redakteur angelegten Eingabe-Felder und die dafür möglichen Eingabewerte.

Folgende Regeln für eine valide POST-Anfrage bestehen:

  • In der Regel sind Select- / Multiselect-Felder sowie Radiobuttons und Checkboxen nur mit den darin definierten Werten absendbar.
  • Die mit

class=“required”

markierten Eingabefelder müssen ausgefüllt sein.

  • Bei Dateiuploads beachten Sie bitte, Ihre Anfrage als

multipart/form-data

zu senden.

  • Sollten in den Feldbezeichnern zwei Felder mit dem Namen “token…” auftauchen, so senden Sie diese Felder nicht mit. Sie benötigen dann von dem Ersteller des Formulars einen API-Schlüssel, den Sie in dem POST-Feld

tokenx

mitsenden müssen.

Tipp: Sie können sich mit der Webdeveloper-Toolbar (bei Chrome und Firefox) die Formular-Eigenschaften ansehen.

Lese-API

Die Lese-API bezieht sich auf die Seite “Formular mit Datenbank”. Die URL für die Abfrage der API wird dabei nach dem Aufrufen des Bearbeitungstools des DB-Backends erzeugt, die Bedienung der API ist in oben genannter Seite erläutert.