Korzystanie z interfejsu API operatora
  • 15 Aug 2023
  • 1 Minuta do przeczytania
  • Współtwórcy

Korzystanie z interfejsu API operatora


Article Summary

Korzystanie z interfejsu API operatora

Jak skonfigurować API operatora

Dodanie operatorów do witryny jest niezbędne do wypełnienia użytkowników, którzy będą uruchamiać aplikacje opracowane w Tulip. Operatorzy są tradycyjnie tworzeni w Ustawieniach przez właścicieli kont. Możesz również utworzyć tych operatorów za pomocą zewnętrznego systemu za pośrednictwem interfejsu API Tulip.

Dodawanie tokenu API operatora

W witrynie Tulip przejdź do swojego profilu w prawym górnym rogu.

Wybierz opcje ustawień z tego menu.

W Ustawieniach wybierz opcję Tokeny API.

Po prawej stronie tej strony wybierz opcję Utwórz token API.

W oknie tworzenia nadaj tokenowi API nazwę i upewnij się, że wybrano zakres Users:Write, a następnie kliknij przycisk Create.

Uwaga: Pamiętaj, aby zapisać informacje o tokenie API dla klucza API, tajnego 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.

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

W sekcji Headers dodaj nagłówek Auth.

W 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:

Naciśnij 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ę, upewnij się, że klucz i sekret są prawidłowe. Więcej informacji na temat konkretnych kodów odpowiedzi można znaleźć w sekcji Dokumentacja API na stronie Tokeny 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!


Czy ten artykuł był pomocny?