Przetestuj interfejsy API Tulip

Prev Next

Advanced Content

This article assumes previous experience with APIs.

Aby dowiedzieć się, jak skonfigurować klucz API, zapoznaj się z artykułami dotyczącymi tabel, operatorów i maszyn.

Użyj łączników Tulip, aby przetestować API Tulip

Feature rename

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

Zapoznaj się z instrukcją konfiguracji łącznika i skonfiguruj go przy użyciu skonfigurowanego konta usługowego API (zobacz ten artykuł, aby dowiedzieć się, jak skonfigurować konto usługowe).

Po skonfigurowaniu łącznika kliknij opcję „Utwórz funkcję”. W tym przykładzie pokażemy, jak pobrać rekordy z tabeli.

Najpierw należy utworzyć żądanie przy użyciu metody GET, POST, PUT, HEAD, PATCH lub DELETE, a następnie podać konkretny adres URL, do którego ma zostać wysłane żądanie (więcej informacji na temat możliwości naszego API można znaleźć tutaj) .

Screenshot 2024-02-28 at 2.35.15 PM.png

NOTE

If you are using a global Service Account, you need to specify the workspace. If your Service Account is workspaced scoped, it is optional.

https://(nazwa_twojej_instancji).tulip.co/api/v3/w/(workspace)/tables/(TableID)/records

Pamiętaj o dodaniu danych uwierzytelniających (z samego konta usługowego), nagłówków żądania (jeśli to konieczne) oraz parametrów zapytania (w samym adresie URL lub jako parametry zapytania — przeczytaj, jak ustawić parametry zapytania, aby uzyskać dodatkowe informacje).

Dodatkowo możesz określić dowolne dane wejściowe lub wyjściowe, które funkcja łącznika może potrzebować do przekazania z powrotem do aplikacji lub automatyzacji.

image.png

Testowanie API Tulip za pomocą Postmana

Poniżej omówiono sposób tworzenia operatora. W tym przykładzie do utworzenia operatora zostanie użyty Postman.

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

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:

Naciśnij przycisk „Wyślij”, aby wysłać żądanie, a otrzymasz odpowiedź 201 potwierdzającą pomyślne wykonanie 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ę, upewnij się, że klucz i sekret są poprawne. Aby uzyskać więcej informacji na temat konkretnych kodów odpowiedzi, zapoznaj się z sekcją Dokumentacja API na stronie Tulip API.

Korzystanie z dokumentacji API w celu przetestowania API Tulip

W ustawieniach obszaru roboczego lub konta przejdź do sekcji „Tulip API”. Następnie kliknij opcję „Dowiedz się więcej” obok opcji „Utwórz konto usługi”.

image.png

Spowoduje to przejście do strony, na której można przetestować API przy użyciu wygenerowanego klucza. Znajduje się tam również dokumentacja oraz przykłady treści żądań dla różnych zastosowań.

Na tej stronie znajduje się również adres URL serwera potrzebny do konfiguracji żądań API z systemów zewnętrznych. Aby zapoznać się z API, kliknij przycisk „Autoryzuj”.

Ten przycisk wyświetli dodatkowe informacje dotyczące konfiguracji interfejsu API do celów testowych. W polach wprowadź następujące dane:

  • Nazwa użytkownika: Klucz API
  • Hasło: Sekret

Kliknij „Autoryzuj”, aby rozpocząć testowanie typowych żądań HTTP dotyczących tabel.

Każdą z opcji na tej stronie można rozwinąć i przetestować. Każde żądanie zawiera przydatne informacje na temat odpowiadających mu odpowiedzi.

Na tej stronie znajdują się również informacje na temat schematów niektórych komponentów Tulip. Na przykład, aby utworzyć rekord w tabeli, warto znać odpowiedni format JSON dla każdej kolumny. Przykładowy schemat kolumn przedstawiono poniżej: