Formularbaukasten-API: Unterschied zwischen den Versionen

Aus Imperia Support Wiki
K
 
Zeile 1: Zeile 1:
Die mittels des [[Formularbaukasten_(Imperia_7)|Formularbaukasten]] gebauten Mini-Applikationen beinhalten von vorne herein [http://de.wikipedia.org/wiki/Representational_State_Transfer REST-APIs].
+
Die mittels des [[Formularbaukasten]] gebauten Mini-Applikationen beinhalten von vorne herein [http://de.wikipedia.org/wiki/Representational_State_Transfer REST-APIs].
  
 
=== Schreib-API ===
 
=== Schreib-API ===
Zeile 5: Zeile 5:
 
Da Formulare des Formularbaukastens durch Imperia-Redakteure definiert werden, ist eine allgemeine Schnittstellenbeschreibung nicht möglich.
 
Da Formulare des Formularbaukastens durch Imperia-Redakteure definiert werden, ist eine allgemeine Schnittstellenbeschreibung nicht möglich.
  
Zum automatisierten Schreiben via Formularen des [[Formularbaukasten_(Imperia_7)|Formularbaukastens]] wird einfach die jeweilige Formularseite verwendet. Sie senden dabei einen POST-Request an die betreffende URL.
+
Zum automatisierten Schreiben via Formularen des [[Formularbaukasten]]s wird einfach die jeweilige Formularseite verwendet. Sie senden dabei einen POST-Request an die betreffende URL.
  
 
[[Bild:form_api.png|thumb|Formulardetails mit der Webdeveloper-Toolbar.]]
 
[[Bild:form_api.png|thumb|Formulardetails mit der Webdeveloper-Toolbar.]]
Zeile 16: Zeile 16:
 
* Die mit <code>class="required"</code> markierten Eingabefelder müssen ausgefüllt sein.
 
* Die mit <code>class="required"</code> markierten Eingabefelder müssen ausgefüllt sein.
 
* Bei Dateiuploads beachten Sie bitte, Ihre Anfrage als <code>multipart/form-data</code> zu senden.
 
* Bei Dateiuploads beachten Sie bitte, Ihre Anfrage als <code>multipart/form-data</code> 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 <code>tokenx</code> mitsenden müssen (siehe [[Formularbaukasten_(Imperia_7)#Formular: Anti-Spam|Formularbaukasten#Formular: Anti-Spam]]).
+
* 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 <code>tokenx</code> mitsenden müssen (siehe [[Formularbaukasten#Formular-Start|Formularbaukasten - Anti-Spam]]).
  
 
Tipp: Sie können mit der Webdeveloper-Toolbar (für Chrome und Firefox) sich die Formular-Eigenschaften ansehen.
 
Tipp: Sie können mit der Webdeveloper-Toolbar (für Chrome und Firefox) sich die Formular-Eigenschaften ansehen.
Zeile 22: Zeile 22:
 
=== Lese-API ===
 
=== Lese-API ===
  
Die Lese-API bezieht sich auf den [[Formularbaukasten mit Datenbankbackend]]. 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 Datenbankbackend]] erläutert.
+
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.
  
  

Aktuelle Version vom 21. Juli 2017, 16:34 Uhr

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.

Datei:Form api.png
Formulardetails mit der Webdeveloper-Toolbar.

Ü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-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 (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.