API
Überblick
Evolution Forms benutzt die WordPress REST API, welche zwei Routen zur Verfügung stellt, um Formulardaten und Formularanfragen (Leads) abzugreifen. Um die API zu benutzen, muss sie im Bereich "Erweiterungen" erworben werden.
Basis URL
Um die API ansteuern zu können, muss in WordPress unter Einstellungen → Permalinks der Eintrag auf Beitragsname gesetzt werden (options-permalink.php
bei deiner WordPress Instanz). HTTPS muss ebenfalls dafür aktiviert sein.
Evolution Forms unterstützt
/evolution-forms/v1/responses
und
/evolution-forms/v1/forms
Hier ist ein Beispiel, wie eine URL aussehen könnte:
https://test.evolution-forms.com/wp-json/evolution-forms/v1/responses
Authentifizierung
Die API benötigt ein Anwendungspasswort, welches in den Benutzereinstellungen getätigt werden kann.
Test Authentifizierung
Du kannst deine Einstellungen im Terminal testen mit cURL:
curl --user "USERNAME:APPLICATION_PASSWORD" https://test.evolution-forms.com/wp-json/wp/v2/users/me
Füge für USERNAME
und APPLICATION_PASSWORD
deine Zugangsdaten ein.
Routen
/wp-json/evolution-forms/v1/forms
Informationen über verfügbare Formulare
Parameter:
formIDs
(Integer-Array): Nach (bestimmten) Formularen suchen. Freilassen, um ALLE Formulare zu erhalten. Es kann auch nach einem Formular mit einer bestimmten ID gesucht werden: /wp-json/evolution-forms/v1/forms/23
/wp-json/evolution-forms/v1/responses
Formularantworten (Leads)
Parameter
formIDs
(Integer-Array): Nach einem Formular mit einer bestimmten ID suchen. Freilassen, um ALLE Formulare zu erhalten.
responseIDs
(String-Array): Nach spezieller Antwort (Lead) suchen
page
(integer): Seitenzahl. Freilassen, um alle Anfragen auf einmal (auf einer Seite) zu erhalten.
detailed
(boolean): Vereint alle Schritte vom Array steps steps
in einem großen Array, namens elements
. Zudem werden Attribute wie stepID
, dateStart
and dateEnd
hinzugefügt.
Beispiele
Formularantworten (Leads) von Formular 22 und 33:
https://test.evolution-forms.com/wp-json/evolution-forms/v1/responses?formIDs[0]=22&formIDs[1]=33
Formularantwort (Lead) mit der ID htUpIvGeNFadxpYk3jCPxXPXm
:
https://test.evolution-forms.com/wp-json/evolution-forms/1v1/responses?responseIDs[0]=htUpIvGeNFadxpYk3jCPxXPXm