Przegląd
Każdy endpoint HTTP API Tillor, z parametrami, przykładowymi żądaniami i playgroundem.
Ostatnio zaktualizowano
Ta dokumentacja jest generowana bezpośrednio z API Tillor. Każdy endpoint ma własną stronę z parametrami, treścią żądania, możliwymi odpowiedziami i przykładami kodu. W panelu bocznym endpointy są pogrupowane tematycznie.
Wysyłanie żądania
Każde żądanie wymaga Twojego klucza API w nagłówku x-api-key. Endpointy pod /orgs/{organizationId} działają w obrębie jednej organizacji.
GET https://api.tillor.eu/orgs/org_abc123/customers
x-api-key: tkn_xxxKlucz API tworzysz w aplikacji, w swoim koncie. Jak to działa, jakie obowiązują limity zapytań i jak bezpiecznie przechowywać klucze, przeczytasz w HTTP API.
Kto może wywołać endpoint
Każda strona endpointu pokazuje na górze, w sekcji Dostęp, kto może go wywołać. W większości przypadków jest to członek organizacji z określonym uprawnieniem, na przykład customers:read. Klucz API działa z uprawnieniami osoby, która go utworzyła; jeśli klucz ma zakresy, uprawnienie musi być też w nich. W przeciwnym razie API odpowiada 403.
Specyfikacja zawiera tę samą informację dla każdego endpointu w x-tillor-access, z access (kto) i permissions (wystarczy jedno).
Wypróbowanie w playgroundzie
Na każdej stronie endpointu możesz od razu wysłać żądanie. Jeśli jesteś zalogowany w Tillor w tej samej przeglądarce, playground używa Twojej sesji i nie potrzebujesz klucza API. W przeciwnym razie wpisz swój klucz API w polu Authorization. Zmień parametry i kliknij Send.
Playground komunikuje się z prawdziwym API Twojej organizacji: POST, PUT lub DELETE zmienia więc prawdziwe dane.
Użyj organizacji testowej
Endpointy zapisujące wypróbowuj na organizacji testowej, nie na działającym parku.
Pobieranie specyfikacji
Pełna specyfikacja jest dostępna jako OpenAPI 3.1 pod adresem tillor.eu/api/openapi.json. Zaimportuj ją do Postmana lub Insomnii albo wygeneruj z niej klienta.