Korzystanie z publicznego API

Publiczne API Upsellr daje dostęp do Twojej master data, produktów, źródeł i workflow z Twoich własnych narzędzi. Jest dostępne w planie Enterprise.

Podstawy

• Adres bazowy: https://api.upsellr.io/v2
• Uwierzytelnianie: każde żądanie zawiera nagłówek Authorization z wartością Bearer, po której następuje Twój klucz. Zobacz tworzenie kluczy API i zarządzanie nimi.
• Dokumentacja: pełna dokumentacja referencyjna, z przykładami, jest opublikowana na docs.upsellr.io.

Wywołania tylko z serwera

API wywołuje się z serwera, nigdy z przeglądarki: nie odpowiada na żądania wysyłane przez stronę internetową. Dzięki temu unikasz też ujawnienia klucza w kodzie strony.

Limity szybkości

Limity dotyczą całej organizacji, łącznie dla wszystkich kluczy.

Typ żądania	Na minutę	Seria
Odczyty	200	30
Zapisy	60	10
Ciężkie zapisy: tworzenie produktów, przesyłanie pliku, uruchamianie workflow	20	5
Wyszukiwanie i odczyt produktów	60	5

Po przekroczeniu limitu API odpowiada kodem 429 i nagłówkiem Retry-After, który wskazuje w sekundach, kiedy spróbować ponownie.

Identyfikator żądania

Każda odpowiedź zawiera nagłówek X-Request-Id. Jeśli żądanie nieoczekiwanie się nie powiedzie, zanotuj ten identyfikator i przekaż go do wsparcia: pozwala dokładnie odnaleźć Twoje wywołanie.

Dobrze wiedzieć

• Klucz ograniczony do określonych adresów IP lub User-Agentów jest odrzucany z każdego innego źródła.
• Zbyt wiele żądań z nieprawidłowym kluczem z tego samego adresu powoduje tymczasową blokadę, sygnalizowaną kodem 429.
• Klucz działa tylko w granicach swoich zakresów: żądanie spoza zakresu jest odrzucane.
• Uruchomienie workflow przez API zużywa kredyty tak samo jak z aplikacji.
• Aby otrzymywać powiadomienia o zakończeniu przetwarzania bez ciągłego odpytywania API, użyj webhooków.
• Masz pytanie? Skorzystaj z formularza kontaktowego lub przycisku Report a bug w aplikacji, podając identyfikator żądania.