Przewodnik po API dla operatorów

Prev Next

Dowiedz się, jak skonfigurować interfejs API operatora

Advanced Content

This article assumes previous experience with APIs.

Dodanie operatorów do witryny jest niezbędne do zapełnienia listy użytkowników, którzy będą korzystać z aplikacji opracowanych w Tulip. Operatorów można tworzyć na dwa sposoby:* Na stronie Użytkownicy, znajdującej się w sekcji Ustawienia* Korzystając z systemu zewnętrznego za pośrednictwem interfejsu API Tulip.

Poniższa procedura pokazuje, jak używać interfejsu API Tulip do tworzenia operatorów.

Dodaj token API operatora

Feature rename

Prior to r383, Service Accounts were called "API Tokens".

W swojej instancji Tulip kliknij ikonę profilu w prawym górnym rogu i wybierz opcję „Ustawienia”.

Configuring Your Tulip Account Settings_124925135

Wybierz opcję „Tulip API”, a następnie kliknij przycisk „Utwórz konto usługowe ” w prawym górnym rogu.

Create%20API%20token1

W menu tworzenia nadaj nazwę tokenowi API i wybierz zakres users:write. Kliknij Utwórz.

Create API Token

Note

Make sure to save the Service Account information for the API Key, Secret, and Authorization Header.

Korzystanie z interfejsu API operatora

Poniżej opisano, jak utworzyć operatora. W tym przykładzie do utworzenia operatora zostanie użyty Postman.

Najpierw dodaj swój punkt końcowy API do żądania POST.

NOTE

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://(nazwa_twojej_instancji).tulip.co/api/v3/w/(workspace)/users

Następnie w sekcji „Authorization” wybierz opcję „Basic Auth” i wprowadź klucz API jako nazwę użytkownika, a sekret API jako hasło.

W sekcji „Headers” dodaj nagłówek „Auth”.

W polu „Treść” sformatuj żądanie tak, aby zawierało obiekt JSON. Ogólny format tego żądania jest następujący.

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

Będzie to wyglądało mniej więcej tak:

Kliknij „Wyślij”, aby wysłać żądanie, a otrzymasz odpowiedź 201 potwierdzającą powodzenie operacji. Aby to zweryfikować, możesz sprawdzić listę użytkowników w sekcji „Ustawienia” i upewnić się, że użytkownik został pomyślnie utworzony.

Jeśli żądanie nie powiodło się, sprawdź, czy klucz i tajny klucz są poprawne. Więcej informacji na temat poszczególnych kodów odpowiedzi znajdziesz w sekcji „Wprowadzenie do interfejsów API”.


Czy znalazłeś to, czego szukałeś?

Możesz również przejść na stronę community.tulip.co, aby zadać pytanie lub sprawdzić, czy inni mieli podobny problem!