Für Ihren Formcentric-Mandanten können Sie eigene API-Clients erstellen, um Formcentric mit externen Systemen wie Ihrem CRM, CMS oder anderen Drittsystemen zu verbinden. So lassen sich Formulardaten automatisiert abrufen, neue Datensätze übertragen oder Workflows integrieren.
Über die API-Clients erhalten Sie Zugangsdaten (Client-ID und Client-Secret), mit denen Sie sich in Ihren Drittsystemen authentifizieren. Die API bietet Ihnen lesenden Zugriff auf:
Alle Formulare - Abrufen von Formulardaten und Metainformationen
Alle Ordner - Zugriff auf die Ordnerstruktur
So erstellen Sie einen API-Client
Klicken Sie rechts oben auf Ihr Profilbild und anschließend auf Admin-Center.
Navigieren Sie in der linken Seitenleiste zu API-Clients.
Klicken Sie rechts oben auf Neuer API-Client.
Vergeben Sie für den API-Client einen aussagekräftigen Namen (Bezeichner) und bestätigen Sie mit Klick auf Erstellen.
Es erscheint ein Modal-Fenster, in dem das Client Secret des neuen API-Clients angezeigt wird.
Wichtig: Kopieren und speichern Sie das Client-Secret sofort an einem sicheren Ort, da es später nicht mehr angezeigt wird.
Sie haben erfolgreich einen neuen API-Client erstellt. Verwenden Sie die generierten Daten - Client-ID und Client-Secret - zur Authentifizierung in Ihrem Drittsystem.
API-Client deaktivieren
Falls Sie einen API-Client temporär außer Betrieb nehmen möchten, können Sie ihn deaktivieren.
Suchen Sie den gewünschten API-Client in der Übersicht.
Klicken Sie auf das Aktionen-Menü (drei Punkte) des entsprechenden Clients.
Wählen Sie Deaktivieren aus.
Sie haben den API-Client deaktiviert. Sie können ihn jederzeit wieder aktivieren, indem Sie im Aktionen-Menü auf Aktivieren klicken.
Den aktuellen Status des API-Clients (aktiv oder deaktiviert) sehen Sie direkt in der Übersicht.
Client-Secret zurücksetzen
Aus Sicherheitsgründen sollten Sie das Client-Secret regelmäßig erneuern oder bei Verdacht auf Kompromittierung sofort zurücksetzen.
Suchen Sie den gewünschten API-Client in der Übersicht.
Klicken Sie auf das Aktionen-Menü (drei Punkte) des entsprechenden Clients.
Wählen Sie Zurücksetzen aus.
Bestätigen Sie die Aktion im erscheinenden Dialog.
Das neue Client-Secret wird in einem Modal-Fenster angezeigt.
Wichtig: Kopieren und speichern Sie das neue Secret sofort, da es nur einmalig angezeigt wird.
Sie haben das Client-Secret zurückgesetzt.
API-Client löschen
Wenn Sie einen API-Client dauerhaft entfernen möchten, können Sie ihn löschen.
Suchen Sie den gewünschten API-Client in der Übersicht.
Klicken Sie auf das Aktionen-Menü (drei Punkte) des entsprechenden Clients.
Wählen Sie Löschen aus.
Bestätigen Sie die Aktion im erscheinenden Dialog.
Sie haben den API-Client dauerhaft gelöscht. Alle damit verbundenen Zugangsdaten sind nicht mehr gültig.
