Formularbaukasten-API
Die mittels des Formularbaukasten gebauten Mini-Applikationen beinhalten von vorne herein REST-APIs.
Schreib-API
Da Formulare des Formularbaukastens durch Imperia-Redakteure definiert werden, ist eine allgemeine Schnittstellenbeschreibung nicht möglich.
Zum automatisierten Schreiben via Formularen des Formularbaukastens 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:
- I.d.R. 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-datazu 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
tokenxmitsenden müssen (siehe Formularbaukasten - Anti-Spam).
Tipp: Sie können mit der Webdeveloper-Toolbar (für Chrome und Firefox) sich die Formular-Eigenschaften ansehen.
Lese-API
Die Lese-API bezieht sich auf den Formularbaukasten 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 beim Formularbaukasten mit Datenbank erläutert.