API-Spielplatz

Der API-Spielplatz ermöglicht es Ihnen, die REST-API von PlatoForms gegen ein bestimmtes Formular zu testen, indem Sie die echten Daten dieses Formulars und ein automatisch ausgefülltes API-Token verwenden. Sie können einen Endpunkt auswählen, einsatzbereite Codebeispiele in mehreren Sprachen sehen und eine Live-Anfrage ausführen, ohne selbst Code schreiben zu müssen. Dieser Leitfaden erklärt, wie Sie auf den Spielplatz zugreifen und ihn nutzen können, um einen Endpunkt zu erkunden.

Zugriff auf den API-Spielplatz

1. Bewegen Sie den Mauszeiger über das gewünschte Formular auf dem Dashboard und klicken Sie auf das Einstellungen (Zahnrad) Symbol in der oberen rechten Ecke.

2. Klicken Sie auf Formular verwalten, um die Einstellungen des Formulars zu öffnen.

   

3. Wählen Sie in der linken Seitenleiste unter Verbinden den API-Spielplatz aus.

Voraussetzungen

Um den API-Spielplatz für ein Formular zu nutzen, müssen die folgenden Anforderungen erfüllt sein:

• Das Formular muss veröffentlicht sein.
• Das Formular muss mindestens eine Übermittlung haben.
• Ihr Team muss sich in einem kostenlosen Testzeitraum oder einem bezahlten Plan befinden.
• Ihre E-Mail-Adresse muss verifiziert sein.

Wenn eine dieser Anforderungen noch nicht erfüllt ist, zeigt die Seite Ein paar Dinge zuerst an, wobei jede Anforderung als erfüllt oder nicht erfüllt markiert ist, zusammen mit dem Grund, wenn sie nicht erfüllt ist (zum Beispiel “Noch keine Übermittlungen aufgezeichnet.”).

Wenn Ihr Team Ihrem Konto keinen API-Zugriff gewährt hat, sehen Sie auch eine Karte für Ihr Team mit einem Zugriff anfordern-Button. Klicken Sie darauf, um Ihren Team-Admin zu benachrichtigen.

Sobald alles erfüllt ist, zeigt die Seite das API-Token Ihres Formulars oben an, bereit zur Verwendung in den untenstehenden Anfragen.

API-Endpunkt erkunden

Der API-Spielplatz bietet Tests für die meisten wichtigen API-Endpunkte, ohne dass Programmierung erforderlich ist. Endpunkte sind nach Kategorien gruppiert. Form, Forms, Einladung, Ich, Übermittlung und mehr.

1. Klicken Sie auf Wählen Sie einen API-Endpunkt zum Erkunden und wählen Sie einen Endpunkt aus der Dropdown-Liste aus. Jeder Endpunkt zeigt seine HTTP-Methode (zum Beispiel GET), eine kurze Beschreibung dessen, was er tut, und die Route, die er aufruft (zum Beispiel GET /v4/form/{form_id}/).

   

   Note

   Für weitere Details zu jedem Endpunkt, konsultieren Sie unsere API-Dokumentation über den API-Dokumente-Button.

2. Wenn Sie mit Programmierung vertraut sind, können Sie Beispielcode in verschiedenen Sprachen kopieren, einschließlich Shell-Befehlen mit Curl, Python, JavaScript, Java oder Golang. Das API-Token Ihres Formulars ist bereits ausgefüllt, sodass die Anfrage sofort ausgeführt werden kann.

   

3. Klicken Sie auf Test ausführen, um eine Anfrage zu stellen und eine Antwort zu generieren.

   

   Sobald die Anfrage abgeschlossen ist, zeigt die Antwort den HTTP-Statuscode und die Dauer der Anfrage an, zusammen mit dem zurückgegebenen JSON. Wenn die Antwort eine URL enthält, können Sie darauf klicken, um die Funktionalität zu testen oder dem Link zu folgen, um das übermittelte Formular anzusehen.

Video-Tutorial