Jak korzystać z interfejsu API operatora

Dowiedz się, jak skonfigurować interfejs API operatora

:::(Info) (Zawartość zaawansowana)Ten artykuł zakłada wcześniejsze doświadczenie z API :::

Dodanie operatorów do witryny jest konieczne, aby wypełnić użytkowników, którzy będą uruchamiać aplikacje opracowane w Tulip. Operatorów można utworzyć na dwa sposoby:* Na stronie Użytkownicy, znajdującej się w Ustawieniach* Używając zewnętrznego systemu poprzez API Tulip.

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

Dodaj token API operatora

W instancji Tulip kliknij ikonę swojego profilu w prawym górnym rogu i wybierz Ustawienia.

Wybierz Tokeny API, a następnie kliknij przycisk Utwórz token API w prawym górnym rogu.

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

:::(Info) (Uwaga) Pamiętaj, aby zapisać informacje o tokenie API dla klucza API, sekretu i nagłówka autoryzacji.:::

Korzystanie z interfejsu API operatora

Poniżej przedstawiono sposób tworzenia operatora. W tym przypadku do utworzenia zostanie użyty Postman.

Najpierw dodaj punkt końcowy API do żądania Post.

:::(Info) (UWAGA) Jeśli używasz globalnego klucza API, musisz określić obszar roboczy. Jeśli klucz API ma zakres obszaru roboczego, jest to opcjonalne :::

https://(yourinstancenamehere).tulip.co/api/v3/w/(workspace)/users

Następnie w sekcji Authorization wybierz Basic Auth i wprowadź API Key jako nazwę użytkownika oraz API Secret jako hasło.

W sekcji Headers dodaj nagłówek Auth Header.

W sekcji Body sformatuj żądanie, aby pobrać obiekt JSON. Ogólny format tego żądania jest następujący.

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

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

Kliknij Wyślij, aby uruchomić żądanie, a otrzymasz odpowiedź 201 oznaczającą powodzenie. Aby to zweryfikować, możesz sprawdzić listę użytkowników w Ustawieniach i potwierdzić, że użytkownik został pomyślnie utworzony.

Jeśli żądanie nie powiodło się, sprawdź, czy klucz i klucz tajny są prawidłowe. Aby uzyskać więcej informacji na temat określonych kodów odpowiedzi, zobacz Wprowadzenie do interfejsów API.

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

Możesz również udać się na stronę community.tulip.co, aby opublikować swoje pytanie lub sprawdzić, czy inni mieli do czynienia z podobnym pytaniem!