Formidable API

Ein umfassender Leitfaden zur Formidable API

Die Formidable API ist ein mächtiges Werkzeug für Entwickler, das die nahtlose Integration von Formularen in verschiedenste Webanwendungen ermöglicht. Mit dieser API können Daten aus Formidable Forms auf beliebige Websites gesendet werden, die über eine REST API verfügen. Ob die Daten gesendet, empfangen oder manipuliert werden sollen – die Formidable API bietet eine flexible Lösung für eine Vielzahl von Anwendungsfällen.

Entwicklung

Installation der Formidable API

Um mit der Formidable API zu beginnen, ist es wichtig, sicherzustellen, dass die aktuelle Version von Formidable Forms auf Ihrer WordPress-Website installiert und aktiviert ist. Gehen Sie zu den Formidable → Add-Ons und aktivieren Sie das Plugin der Formidable API.

API-Schlüssel generieren

Der Zugang zur Formidable API erfolgt über einen API-Schlüssel. Um diesen zu erhalten, navigieren Sie zu Formidable → Global Settings → API. Dort finden Sie den Schlüssel, den Sie für die Authentifizierung Ihrer API-Anfragen benötigen. Der API-Schlüssel wird in der Datenbank in der Tabelle wp_options gespeichert und ist standardmäßig 19 Zeichen lang. Es wird dringend empfohlen, HTTPS für Ihre Verbindung zu verwenden, um die Sicherheit Ihrer API-Anfragen zu erhöhen.

API-Aktionen konfigurieren

Um Daten über die Formidable API zu senden, müssen Sie Ihre Formularaktionen richtig einrichten. Gehen Sie dazu in die Einstellungen des jeweiligen Formulars und wählen Sie den Abschnitt „Aktionen & Benachrichtigungen“. Fügen Sie eine neue Aktion hinzu, um die API-Daten zu senden. Hier können Sie den Aktionsnamen, die Triggerbedingungen sowie die Benachrichtigungs-URL und Ihren API-Schlüssel eingeben.

Arbeiten mit HTTP-Methoden

Die Formidable API unterstützt verschiedene HTTP-Methoden, um mit den gesendeten und empfangenen Daten zu interagieren:

• GET: Abrufen von Einträgen ohne Veränderung der Daten. Beispiel: GET yoursite.com/wp-json/frm/v2/entries
• POST: Erstellen neuer Einträge. Beispiel: POST yoursite.com/wp-json/frm/v2/entries
• PUT/PATCH: Aktualisieren bestehender Einträge mit den jeweiligen ID-Referenzen.
• DELETE: Löschen eines Eintrags, ebenfalls unter Angabe der ID.

API-Routen und Eingaben

Die Routen der Formidable API ermöglichen es Entwicklern, gezielt auf verschiedene Daten zuzugreifen:

• GET /wp-json/frm/v2/entries: Erhält alle Einträge aller Formulare.
• POST /wp-json/frm/v2/entries: Erstellt einen neuen Eintrag.
• GET /wp-json/frm/v2/forms/#/entries: Erhält alle Einträge eines bestimmten Formulars, wobei # die Formular-ID ersetzt.

Beispiel für API-Datenübertragung

Um die Daten eines Eintrags an eine andere Website zu senden, fügen Sie im Benachrichtigungs-URL-Feld die Ziel-URL hinzu, an die die Daten gesendet werden sollen, unter Verwendung des API-Schlüssels für die Authentifizierung. Achten Sie darauf, dass die Daten im erforderlichen Format (JSON, Form, oder Raw) gesendet werden. Hier ein einfaches Beispiel einer JSON-Nutzlast:

json
{
"form_id": "12",
"field_key": "value"
}

Nutzung von Drittanbieter-APIs

Mit der Formidable API können Sie nicht nur innerhalb Ihrer WordPress-Installation mit Formidable Forms kommunizieren, sondern auch externe APIs wie Zapier ansteuern. Beispielsweise können Sie einen Eintrag an Zapier senden, um ihn zu verarbeiten oder in einen anderen Dienst zu integrieren. Wenn Sie eine externe API kontaktieren müssen, tragen Sie deren API-Endpoint in das entsprechende Benachrichtigungs-URL-Feld ein.

Automatisierte Einträge und komplexe Anfragen

Für komplexe Anwendungsfälle können Sie die Formidable API in Kombination mit der Automatisierungsfunktion verwenden, um Einträge innerhalb von Minuten nach einer ursprünglichen Anfrage zu aktualisieren oder neue Einträge zu erstellen. Dies ermöglicht eine Vielzahl von Funktionen, wie das automatische Löschen von Einträgen nach einem bestimmten Datum.

Beispiel für eine API-Anfrage

Hier ist ein Beispiel, das zeigt, wie man mit PHP eine POST-Anfrage an die Formidable API zur Erstellung eines neuen Eintrags sendet:

php
$url = 'http://yoursite.com/wp-json/frm/v2/entries/';
$response = wp_remote_post($url, array(
'method' => 'POST',
'timeout' => 45,
'headers' => array(
'Authorization' => 'Basic ' . base64_encode($api_key . ':x')
),
'body' => json_encode(array('form_id' => 'id_oder_field_key', 'data' => 'wert'))
));

In diesem Beispiel ersetzen Sie ‘id_oder_field_key‘ mit der passenden ID oder dem Schlüssel des Feldes, das Sie erstellen möchten.

Fehlerbehebung und Debugging

Wenn Sie bei der Arbeit mit der Formidable API auf Fehler stoßen, können Sie spezielle Protokolle aktivieren, um detaillierte Informationen über den Fehler oder die API-Anfragen zu erhalten. Dies ist entscheidend, um einen reibungslosen Betrieb sicherzustellen und Anpassungen vorzunehmen.

Fazit

Die Formidable API ist ein extrem flexibles und mächtiges Werkzeug für die Entwicklung von Webanwendungen, das die Integration komplexer Datenspeicher- und Verarbeitungsfunktionen ermöglicht. Mit ihrer Unterstützung für verschiedene HTTP-Methoden, einfache Routenkonfiguration und Sicherheitsoptionen wie API-Schlüssel und HTTPS, stellt sie sicher, dass alle Datenanfragen effizient und sicher verarbeitet werden. Nutzen Sie die Möglichkeiten der Formidable API, um Ihre Webanwendungen auf das nächste Level zu heben.