API und Webhooks
Tabs
Dieses Kapitel ist ein Leitfaden für Entwickler, die die API- und Webhooks-Seite nutzen. Erhalten Sie Einblicke in die Nutzung dieser Tools.
Zugriff auf die API- und Webhooks-Seite
-
Melden Sie sich in Ihrem Dashboard an.
-
Klicken Sie in der oberen rechten Ecke des Dashboards auf Ihr Profilfoto und wählen Sie API Webhooks.
Überprüfen Sie den Status des API-Zugriffs
Auf der sich öffnenden Seite können Sie den Status Ihres API-Zugriffs überprüfen.
Webhook-Endpunkte konfigurieren
Richten Sie Endpunkte ein, um Echtzeitbenachrichtigungen zu erhalten, wenn Formulare eingereicht werden oder andere Ereignisse eintreten. Nützlich zur Integration von Formulardaten in andere Anwendungen oder Dienste.
Klicken Sie auf + Endpunkt hinzufügen, um einen neuen zu erstellen, oder auf Bearbeiten, um einen bestehenden Endpunkt zu ändern.
Erstellen einer OAuth2-Anwendung
Die APIs von PlatoForms sind durch das OAuth2-Protokoll geschützt, ein sicheres Authentifizierungs- und Autorisierungs-Framework. Eine “OAuth2-Anwendung” bezieht sich auf eine registrierte Anwendung, die OAuth 2.0 zur Interaktion mit dem System nutzt.
Durch das Erstellen einer OAuth2-Anwendung können Sie sicher eine Client-ID und ein Client-Geheimnis über einen Authentifizierungsprozess erhalten. Dies erleichtert die sichere Autorisierung anderer Anwendungen, um auf die API der Plattform zuzugreifen. Die Erstellung einer ‘OAuth2-Anwendung’ richtet die wesentlichen Komponenten für eine sichere Integration ein, die Interaktionen mit der API unter Verwendung von OAuth2 für sowohl Authentifizierung als auch Autorisierung ermöglicht.
Um eine OAuth2-Anwendung zu erstellen:
-
Klicken Sie auf + Anwendung hinzufügen.
-
In dem sich öffnenden Fenster:
-
Geben Sie einen Namen für Ihre Anwendung an, der hilft, sie im System zu identifizieren.
-
Geben Sie eine Umleitungs-URL an, die für den OAuth2-Fluss entscheidend ist.
-
-
Bestätigen Sie Ihre Einstellungen, indem Sie auf Speichern klicken.
Sobald die Anwendung gespeichert ist, generiert das System eine eindeutige Client-ID und ein Client-Geheimnis.
Tokens erstellen und zurücksetzen
Wenn Sie als Entwickler einen verlängerten API-Zugriff benötigen, bietet die Plattform die Möglichkeit, nicht ablaufende Tokens zu erstellen und zurückzusetzen. Diese Funktion eliminiert die Notwendigkeit regelmäßiger Token-Aktualisierungen und gewährleistet einen ununterbrochenen und erweiterten API-Zugriff.
Klicken Sie einfach auf Token erstellen oder zurücksetzen, um ein neues Token zu generieren, und verwenden Sie Löschen, um ein vorhandenes Token bei Bedarf zu entfernen. Diese Funktionalität vereinfacht den Prozess der Verwaltung des langfristigen Zugriffs auf die API.