So verwenden Sie die Operator-API

Verwendung der Operator-API

Wie man die Operator API einrichtet

Das Hinzufügen von Betreibern zu Ihrer Website ist notwendig, um die Benutzer zu erfassen, die die in Tulip entwickelten Anwendungen ausführen werden. Betreiber werden traditionell in den Einstellungen von Kontobesitzern erstellt. Sie können diese Betreiber auch mit einem externen System über die Tulip API erstellen.

Hinzufügen eines Operator API Token

Navigieren Sie auf Ihrer Tulip-Website zu Ihrem Profil in der oberen rechten Ecke.

Wählen Sie in diesem Menü die Optionen Einstellungen.

Innerhalb der Einstellungen wählen Sie die Option API Token.

Auf der rechten Seite dieser Seite wählen Sie API Token erstellen.

Geben Sie dem API-Token in der Erstellungsphase einen Namen und stellen Sie sicher, dass der Bereich Benutzer:Schreiben ausgewählt ist. Klicken Sie dann auf Erstellen.

Hinweis: Stellen Sie sicher, dass Sie die API-Token-Informationen für den API-Schlüssel, das Geheimnis und den Autorisierungs-Header speichern.

Verwenden der Operator-API

Im Folgenden wird beschrieben, wie Sie einen Operator erstellen. In diesem Fall verwendet das Beispiel Postman für die Erstellung.

Fügen Sie zunächst Ihren API-Endpunkt in die Post-Anforderung ein.

:::(Info) (HINWEIS) Wenn Sie einen globalen API-Schlüssel verwenden, müssen Sie den Arbeitsbereich angeben. Wenn Ihr API-Schlüssel arbeitsbereichsspezifisch ist, ist die Angabe optional. :::

https://(IhrInstallationsnamehier).tulip.co/api/v3/w/(Arbeitsbereich)/Tabellen/(TabellenID)/Datensätze

Wählen Sie dann unter Autorisierung die Option Basisautorisierung und geben Sie den API-Schlüssel als Benutzernamen und das API-Geheimnis als Passwort ein.

Fügen Sie unter Header den Auth Header hinzu.

Im Body formatieren Sie die Anfrage, um das JSON-Objekt zu übernehmen. Das generische Format für diese Anfrage ist wie folgt.

{ "Rolle": "operator", "name": "string", "badge_id": "string" }

Dies sieht in etwa so aus:

Klicken Sie auf "Senden", um die Anfrage auszuführen, und Sie erhalten eine 201-Antwort, die den Erfolg anzeigt. Um dies zu überprüfen, können Sie Ihre Benutzerliste in den Einstellungen überprüfen und bestätigen, dass der Benutzer erfolgreich erstellt wurde.

Wenn die Anfrage fehlgeschlagen ist, überprüfen Sie, ob der Schlüssel und das Geheimnis korrekt sind. Weitere Informationen zu bestimmten Antwortcodes finden Sie im Abschnitt API-Dokumentation auf der Seite API-Tokens.

Haben Sie gefunden, wonach Sie gesucht haben?

Sie können auch auf community.tulip.co Ihre Frage stellen oder sehen, ob andere mit einer ähnlichen Frage konfrontiert wurden!