Erfahren Sie, wie Sie die Operator-API einrichten
This article assumes previous experience with APIs.
Das Hinzufügen von Bedienern zu Ihrer Website ist erforderlich, um die Benutzer anzulegen, die die in Tulip entwickelten Apps ausführen werden. Sie können Bediener auf zwei Arten erstellen:* Über die Seite „Benutzer“ in den Einstellungen* Über ein externes System mithilfe der Tulip-API.
Die folgende Anleitung zeigt, wie Sie die Tulip-API zum Anlegen von Bedienern verwenden.
Hinzufügen eines Operator-API-Tokens
Prior to r383, Service Accounts were called "API Tokens".
Klicken Sie in Ihrer Tulip-Instanz auf Ihr Profilsymbol in der oberen rechten Ecke und wählen Sie „Einstellungen“ aus.
Wählen Sie „Tulip-API“ aus und klicken Sie dann oben rechts auf die Schaltfläche „Dienstkonto erstellen “.
Geben Sie im Menü „Erstellung“ dem API-Token einen Namen und wählen Sie den Geltungsbereich „users:write “ aus. Klicken Sie auf „Erstellen“.
Make sure to save the Service Account information for the API Key, Secret, and Authorization Header.
Verwendung der Operator-API
Im Folgenden wird erläutert, wie Sie einen Operator erstellen. In diesem Beispiel wird die Erstellung mit Postman durchgeführt.
Fügen Sie zunächst Ihren API-Endpunkt zur POST-Anfrage hinzu.
If you are using a global API key, you need to specify the workspace. If your API key is workspaced scoped, it is optional.
https://(yourinstancenamehere).tulip.co/api/v3/w/(workspace)/users
Wählen Sie anschließend unter „Authorization“ die Option „Basic Auth“ aus und geben Sie den API-Schlüssel als Benutzernamen sowie das API-Geheimnis als Passwort ein.
Fügen Sie unter „Headers“ den Auth-Header hinzu.
Formatieren Sie die Anfrage im „Body“ so, dass sie das Objekt JSON enthält. Das allgemeine Format für diese Anfrage lautet wie folgt:
{"role": "operator","name": "string","badge_id": "string"}
Das sieht dann in etwa so aus:
Klicken Sie auf „Senden“, um die Anfrage auszuführen. Sie erhalten eine 201-Antwort, die den Erfolg bestätigt. Zur Überprüfung können Sie Ihre Benutzerliste unter „Einstellungen“ aufrufen und sich vergewissern, dass der Benutzer erfolgreich angelegt wurde.
Falls die Anfrage fehlgeschlagen ist, überprüfen Sie, ob der Schlüssel und der Geheimcode korrekt sind. Weitere Informationen zu bestimmten Antwortcodes finden Sie unter „Einführung in APIs“.
Haben Sie gefunden, wonach Sie gesucht haben?
Sie können auch auf community.tulip.co vorbeischauen, um Ihre Frage zu stellen oder zu sehen, ob andere bereits ein ähnliches Problem hatten!