Skonfiguruj i korzystaj z interfejsu API Tulip, aby komunikować się z platformą Tulip z poziomu innych systemów.
This article assumes previous experience with APIs.
Tulip komunikuje się z interfejsami API wielu innych systemów za pośrednictwem łączników (Connectors). Korzystając z łączników, aplikacja Tulip może zainicjować zapytanie HTTP lub SQL.
W innych przypadkach może zaistnieć potrzeba umożliwienia systemowi zewnętrznemu wysyłania zapytań o dane, które istnieją wyłącznie w Tulip. Komunikacja z Tulip z poziomu systemów zewnętrznych jest możliwa za pomocą interfejsu API Tulip. W niniejszym artykule omówiono proces konfiguracji i testowania interfejsu API Tulip.
Interfejs API Tulip jest przydatny do integracji tych zewnętrznych systemów z Tulip na wiele sposobów. Obecnie interfejs API działa wyłącznie z tabelami Tulip. Może to obejmować aktualizację rekordu w tabeli o nowe informacje, utworzenie tabeli lub uzyskanie liczby rekordów w tabeli.
Funkcjonalność interfejsu API stacji
API stacji może pomóc w szybkim zarządzaniu stacjami i wdrażaniu nowych. Ogólna funkcjonalność obejmuje tworzenie, wyświetlanie listy oraz modyfikowanie stacji, grup stacji i interfejsów (wcześniej nazywanych urządzeniami wyświetlającymi). Więcej informacji znajdziesz tutaj.
Można na przykład napisać skrypt, który pozwoli automatycznie wysyłać link do konfiguracji nowego interfejsu za każdym razem, gdy dodawany jest nowy użytkownik.
Przewodnik
Prior to r383, Service Accounts were called "API Tokens".
Konfiguracja interfejsu API Stacji
Zapoznaj się z tym artykułem, aby dowiedzieć się, jak skonfigurować konto usługowe.
If you have a Service Account already set up, you may use that API Key and Secret
- W ustawieniach konta wybierz zakładkę „Tulip API ”.
- Kliknij opcję Utwórz konto usługowe.
- Nadaj nazwę kontu usługowemu.
- W polu Zakresy wybierz opcje
„stacje: odczyt” i„stacje: zapis”:

Make sure to save the Service Account information for the API Key, Secret, and Authorization Header.
- Kliknij „Zapisz”.
Korzystanie z interfejsu API stacji
Po skonfigurowaniu interfejsu API Stacji możesz utworzyć stację. W tym przykładzie do utworzenia stacji użyto narzędzia Postman.
- Dodaj swój punkt końcowy API do żądania POST.

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

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

Podczas tworzenia żądania uwzględnij obszar roboczy. Przykład:<nazwa-twojej-instancji>.tulip.co/api/stations/v1/w/1/stations W tym przykładzie wysyłane jest żądanie do punktu końcowego „stations”. Jeśli nie masz obszaru roboczego, ustaw wartość 1.
- Kliknij „Wyślij”, aby wysłać żądanie, a otrzymasz odpowiedź 200 potwierdzającą pomyślne wykonanie operacji.
Aby to sprawdzić, przejdź do strony „Stacje” w zakładce „Hala produkcyjna ” i upewnij się, że stacja została utworzona.

