Používání veřejného API
Základní adresa, ověřování, limity počtu požadavků a identifikátor požadavku: to podstatné pro napojení vašich nástrojů na Upsellr.
Veřejné API Upsellr dává z vašich vlastních nástrojů přístup k vašim master data, produktům, zdrojům a workflow. Je součástí tarifu Enterprise.
To podstatné
- Základní adresa:
https://api.upsellr.io/v2 - Ověřování: každý požadavek nese hlavičku Authorization s hodnotou Bearer, za kterou následuje váš klíč. Viz vytváření a správa API klíčů.
- Dokumentace: úplná reference s příklady je zveřejněna na docs.upsellr.io.
Volání jen ze serveru
API se volá ze serveru, nikdy z prohlížeče: na požadavky odeslané webovou stránkou neodpovídá. Tím se také vyhnete odhalení klíče v kódu stránky.
Limity počtu požadavků
Limity platí pro celou organizaci, pro všechny klíče dohromady.
| Typ požadavku | Za minutu | Nárazově |
|---|---|---|
| Čtení | 200 | 30 |
| Zápisy | 60 | 10 |
| Náročné zápisy: vytváření produktů, nahrání souboru, spuštění workflow | 20 | 5 |
| Vyhledávání a čtení produktů | 60 | 5 |
Při překročení API odpoví kódem 429 a hlavičkou Retry-After, která v sekundách udává, kdy to zkusit znovu.
Identifikátor požadavku
Každá odpověď nese hlavičku X-Request-Id. Pokud požadavek nečekaně selže, poznamenejte si tento identifikátor a předejte ho podpoře: umožní přesně dohledat vaše volání.
Dobré vědět
- Klíč omezený na určité IP adresy nebo určité User-Agenty je z jakéhokoli jiného původu odmítnut.
- Příliš mnoho požadavků s neplatným klíčem ze stejné adresy vede k dočasnému zablokování, které signalizuje kód 429.
- Klíč funguje jen v mezích svých oprávnění: požadavek mimo oprávnění je odmítnut.
- Spuštění workflow přes API spotřebovává kredity stejně jako z aplikace.
- Chcete-li být upozorněni na konec zpracování, aniž byste se API opakovaně dotazovali, použijte webhooky.
- Máte dotaz? Použijte kontaktní formulář nebo tlačítko Report a bug v aplikaci, i s identifikátorem požadavku.