Jak korzystać z interfejsu API tabeli

Cel

Skonfigurowanie i używanie API Tulip do interakcji z Tulip z innych systemów.

Uwaga: Artykuł zaawansowany.

Zakłada wcześniejsze doświadczenie z API.

:::(Info) (UWAGA) Artykuł zaawansowany: Zakłada wcześniejsze doświadczenie z API :::

Tulip współdziała z wieloma interfejsami API innych systemów za pośrednictwem konektorów. Aplikacja Tulip może zainicjować zapytanie HTTP lub SQL.

W innych przypadkach możesz chcieć zezwolić zewnętrznemu systemowi na zapytanie o dane, które istnieją tylko w Tulip. Możliwe jest komunikowanie się z Tulip z systemów zewnętrznych za pomocą Tulip API. W tym artykule omówimy konfigurację i testowanie interfejsu API Tulip.

API Tulip jest przydatne do integracji tych zewnętrznych systemów z Tulip na wiele sposobów. API działa obecnie tylko z tabelami Tulip. Może to obejmować aktualizację rekordu tabeli o nowe informacje, tworzenie tabeli lub uzyskiwanie liczby rekordów w tabeli.

Dodawanie API

Przejdź do strony ustawień swojego konta Tulip.

W menu Ustawienia wybierz Tokeny API.

Ta strona pozwala skonfigurować "Tokeny API", które są konfiguracjami API wyposażonymi w klucz API, sekret i nagłówek autoryzacji. Aby dodać token API, wybierz przycisk Dodaj token API w prawym górnym rogu tej strony. Po wybraniu skonfiguruj token API zgodnie z potrzebami.

Nadaj tokenowi API nazwę i zdefiniuj zakresy, które będzie mógł wykonywać. W tym przykładzie token API może odczytywać z tabel Tulip, a także zapisywać do nich. Tokeny API można archiwizować, jeśli nie są używane.

Po kliknięciu przycisku Utwórz podane zostaną informacje API. Pamiętaj, aby zapisać te informacje, ponieważ nie można uzyskać do nich dostępu ponownie!

Informacje te można teraz wykorzystać do skonfigurowania połączenia z API Tulip.

Testowanie API

Zamknij wyskakujące okienko informacyjne i przejdź do przycisku Dokumentacja API, obok opcji Utwórz token API.

Spowoduje to przejście do strony, która umożliwia testowanie interfejsu API z utworzonym kluczem. Zawiera ona również dokumentację i przykłady żądań dla różnych zastosowań.

Ta strona zawiera również adres URL serwera potrzebny do skonfigurowania żądań API z systemów zewnętrznych. Aby zapoznać się z interfejsem API, kliknij przycisk Authorize.

Ten przycisk zawiera dodatkowe informacje na temat konfiguracji interfejsu API do celów testowych. W polach wprowadź następujące dane:

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

Kliknij przycisk autoryzacji i możesz rozpocząć testowanie niektórych typowych żądań HTTP dla Tables.

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 o schematach dla niektórych komponentów Tulip. Na przykład, aby utworzyć rekord tabeli, warto znać odpowiednie formatowanie JSON dla każdej kolumny. Przykładowy schemat dla kolumn pokazano poniżej:

Zapytania z filtrami

Filtry mogą być bardzo przydatne do wyodrębniania tylko tych danych, którymi jesteś zainteresowany. Filtry te mogą być czasami nieco skomplikowane w swojej składni. Poniżej przedstawiono sposób tworzenia każdego z nich w przykładzie żądania GET dla rekordów, a następnie pełny przykład.

Nazwy pól niestandardowych są zawsze poprzedzone pięciocyfrowym identyfikatorem łańcuchowym. Można je najłatwiej znaleźć po żądaniu GET all, aby sprawdzić prawdziwą nazwę pola.

• Np. "field"="maytq_scrap_count".

Wartościargumentów są często proste. Jeśli jest to wartość tekstowa, należy umieścić ją w cudzysłowie.

• Np. "arg":15

Dopasuj typ funkcji, której chcesz użyć.

• Np. "functionType": "greaterThan"

Pełne żądanie może wyglądać mniej więcej tak:

https://brian.tulip.co/api/v3/tables/W2HPvyCZrjMMHTiip/records?limit=100&sortBy=\_sequenceNumber&sortDir=asc&filters=[{"field": "maytq\_scrap\_count", "arg":15, "functionType": "greaterThan"}]&filterAggregator=any

Wiele filtrów

W niektórych przypadkach możesz mieć wiele filtrów do sprawdzenia w tabeli. W takim przypadku można dodać wiele filtrów do obiektu filters. Może to wyglądać mniej więcej tak:

filters=[{"field": "maytq\_scrap\_count", "arg":15, "functionType": "greaterThan"},{"field": "maytq\_scrap\_reason", "arg": "scratch", "functionType": "equal"}].

Przykłady

Poniższe przykłady przedstawiają proces tworzenia żądań do interfejsu API Tulip. Przykłady te wykorzystują Postman do wysyłania żądań z Tulip.

Pobierz nazwy tabel i informacje

To żądanie Get pozwala zewnętrznemu systemowi pobrać identyfikatory i informacje o kolumnach wszystkich tabel w instancji Tulip. Może to być przydatne jako metoda znalezienia interesującej tabeli w celu skonfigurowania żądania POST.

W Postmanie ustaw Authorization na Basic Auth i wprowadź API Key i Secret.

Teraz żądanie musi trafić we właściwe miejsce. W Tulip znajdź żądanie, które chcesz wykonać z dokumentacji API. W tym przypadku żądaniem jest uzyskanie wszystkich informacji o tabeli.

Aby uzyskać adres URL żądania, uruchom przycisk Wykonaj i sprawdź informacje o żądaniu.

Ten adres URL żądania może być następnie użyty jako adres URL serwera do przetworzenia żądania GET z Postmana.

Naciśnij Wyślij, a żądanie zwróci wszystkie informacje z tabel.

Tworzenie rekordu tabeli

Używając POST i identyfikatora tabeli znalezionego powyżej, można utworzyć rekord tabeli z systemu zewnętrznego. Autoryzacja i nagłówek pozostaną takie same, ale adres URL żądania będzie nieco inny.

Najpierw określ tabelę, w której chcesz utworzyć rekord. Adres URL żądania będzie zawsze miał następującą strukturę:

https://.tulip.co/api/v3/tables//records

Po wprowadzeniu, żądanie będzie również wymagało treści, aby poprawnie przetworzyć POST. Schemat kolumn podano powyżej w sekcji Testowanie i można go znaleźć w dokumentacji API. Jedyną kolumną, która jest w pełni niezbędna, aby to się powiodło, jest kolumna ID. W przypadku wszelkich innych kolumn, które nie zostaną dodane, będą one przechowywane jako null w rekordzie tabeli po utworzeniu. Dodaj tę zawartość jako Body dla żądania.

Po przesłaniu Postman zweryfikuje, czy rekord został utworzony.

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!