REST API
REST API: katalog Upsellr sterowany z własnych narzędzi.
Twórz produkty z systemu ERP, przesyłaj pliki od dostawców, uruchamiaj wzbogacanie i generowanie, a następnie odczytuj treści napisane dla każdego kanału i każdego języka. Udokumentowane REST API z kluczami o ograniczonych uprawnieniach.
- Kategoria
- API
- Kierunek
- Odczyt i zapis
- Wersja
- REST v2, specyfikacja OpenAPI
- Klucze
- Do 10 na organizację, uprawnienia do wyboru
- Języki
- Etykiety po francusku, angielsku, hiszpańsku i niemiecku
- Uwierzytelnianie
- Klucz API w nagłówku Authorization
- Plany
- Plan Enterprise
- Wydawca
- Upsellr
01Co robi API
Upsellr z poziomu własnych narzędzi.
- 01
Twórz produkty partiami
Wysyłaj do 100 produktów w jednym wywołaniu. Upsellr rozpoznaje je po EAN, SKU lub kodzie producenta i marce: znany już produkt nie jest duplikowany, tylko otrzymuje nową wersję, gdy zmieni się jakaś wartość.
- 02
Odczytuj master data
Pola, listy wartości, kategorie i szablony: wszystko, co porządkuje katalog, można odczytać przez API, z etykietami w wybranym języku.
- 03
Przesyłaj pliki od dostawców
Umieszczaj arkusze kalkulacyjne i pliki PDF w bibliotece plików Upsellr: do 10 MiB w jednym przesłaniu, powyżej w kilku częściach.
- 04
Uruchamiaj wzbogacanie i generowanie
Uruchom proces dla zaznaczenia, wyników wyszukiwania lub całego katalogu, do 50 000 produktów: Lily wzbogaca master data, Max pisze karty dla kanałów albo wykonuje się jeden z workflow.
- 05
Odczytuj wygenerowane treści
Każdy produkt zwraca swoje master data, zaimportowane wartości i wygenerowane treści, uporządkowane według kanału i języka.
- 06
Śledź procesy
Proces można śledzić przez API lub webhook: zakończony, nieudany lub zatrzymany, narzędzie dostaje powiadomienie.
02Pierwsze kroki
Pierwsze zapytanie w kilka minut.
- 01
Otwórz ustawienia organizacji
Sekcja API i webhooki, dostępna tylko dla właścicieli i administratorów.
- 02
Utwórz klucz
Wybierz uprawnienia: tylko odczyt, odczyt i zapis lub pełny dostęp. W razie potrzeby dodaj datę wygaśnięcia i dozwolone adresy IP.
- 03
Podłącz go do narzędzia
Klucz przesyła się w nagłówku Authorization każdego wywołania.
- 04
Wywołuj API z serwera
Nie wywołuje się go z przeglądarki: klucze pozostają po stronie serwera.
- 05
Śledź procesy
Przez API lub za pomocą webhooka, który powiadamia o zakończeniu każdego procesu.
03Zasoby
Co API pozwala odczytać i zapisać.
| Zasób | Odczyt | Zapis |
|---|---|---|
| Produkty | Tak | Tak |
| EAN, SKU i kod producenta | Tak | Tak |
| Wartości master data | Tak | Tak |
| Wygenerowane treści, według kanału i języka | Tak | Nie |
| Pola i listy master data | Tak | Nie |
| Pliki źródłowe | Tak | TakDo 10 MiB lub w kilku częściach |
| Procesy wzbogacania i generowania | Tak | Tak |
| Cena |
Kompatybilność i wymagania
- Plan Enterprise
- Rola właściciela lub administratora do tworzenia kluczy
- Serwer do wywoływania API, nigdy przeglądarka
- Nagłówek Authorization: Bearer w każdym wywołaniu
- Wskazówka: jeden klucz na narzędzie, tylko z potrzebnymi uprawnieniami
Masz pełną kontrolę
Klucze pod kontrolą.
- Uprawnienia dla każdego klucza: tylko odczyt, odczyt i zapis lub pełny dostęp
- Data wygaśnięcia i dozwolone adresy IP, w razie potrzeby
- Limity wywołań na organizację, sygnalizowane po przekroczeniu
- Identyfikator żądania w każdej odpowiedzi, dla wsparcia technicznego
04Pytania
Pytania o API Upsellr.
Czy API jest dostępne w moim planie?
Jest dostępne wyłącznie w planie Enterprise. W pozostałych planach sekcja API i webhooki jest widoczna, ale zablokowana.
Gdzie znaleźć dokumentację?
Dokumentacja referencyjna API jest generowana ze specyfikacji OpenAPI i zawiera przykłady w curl, JavaScript, Python i Ruby.
Jakie są limity wywołań?
Na organizację: 200 odczytów i 60 zapisów na minutę oraz 20 na minutę dla operacji obciążających, takich jak tworzenie produktów, przesyłanie plików i uruchamianie procesów. Po przekroczeniu API odpowiada kodem 429 wraz z czasem oczekiwania.
Czy mogę zmienić lub usunąć produkt przez API?
Jeszcze nie. Przez API tworzy się produkty, a ponowne wysłanie istniejącego produktu nadaje mu nową wersję, gdy zmieni się jakaś wartość. Zmiany i usuwanie wykonuje się w Upsellr.
Jak uniknąć duplikatów?
Upsellr rozpoznaje każdy produkt po EAN, SKU lub kodzie producenta i marce: ponowne wysłanie tego samego produktu nie tworzy duplikatu.
Czy mogę uruchomić wzbogacanie z własnego narzędzia?
Tak. Uruchom wzbogacanie, generowanie, oba naraz lub jeden z workflow dla zaznaczenia, wyników wyszukiwania lub całego katalogu, do 50 000 produktów na proces.
Skąd wiadomo, że proces się zakończył?
Odpytaj proces przez API albo odbierz webhook, gdy proces się zakończy, nie powiedzie lub zostanie zatrzymany.
Czy istnieje SDK?
Na razie nie: API to klasyczne REST API, a dokumentacja referencyjna zawiera przykłady gotowe do skopiowania.
Twój kolejny produkt
zasługuje na więcej niż kopiuj-wklej.
Daj swojemu zespołowi AI pierwsze produkty do pracy.
Marcus
Amazon