Använda det publika API:et
Basadress, autentisering, hastighetsgränser och förfrågnings-ID: det viktigaste för att koppla dina verktyg till Upsellr.
Upsellrs publika API ger åtkomst till din masterdata, dina produkter, dina källor och dina workflows från dina egna verktyg. Det ingår i planen Enterprise.
Det viktigaste
- Basadress:
https://api.upsellr.io/v2 - Autentisering: varje förfrågan har rubriken Authorization med värdet Bearer följt av din nyckel. Se skapa och hantera API-nycklar.
- Dokumentation: den fullständiga referensen, med exempel, publiceras på docs.upsellr.io.
Anrop endast från en server
API:et anropas från en server, aldrig från en webbläsare: det svarar inte på förfrågningar som skickas från en webbsida. Det förhindrar också att din nyckel exponeras i en sidas kod.
Hastighetsgränserna
Gränserna gäller hela organisationen, för alla nycklar sammantaget.
| Typ av förfrågan | Per minut | Topp |
|---|---|---|
| Läsningar | 200 | 30 |
| Skrivningar | 60 | 10 |
| Tunga skrivningar: skapa produkter, ladda upp fil, starta workflow | 20 | 5 |
| Sökning och läsning av produkter | 60 | 5 |
Över gränsen svarar API:et med koden 429 och en rubrik Retry-After som anger, i sekunder, när du kan försöka igen.
Förfrågnings-ID
Varje svar har en rubrik X-Request-Id. Om en förfrågan misslyckas oväntat, anteckna detta ID och skicka det till supporten: det gör det möjligt att hitta exakt ditt anrop.
Bra att veta
- En nyckel som är begränsad till vissa IP-adresser eller vissa User-Agents nekas från alla andra ursprung.
- För många förfrågningar med en ogiltig nyckel från samma adress leder till en tillfällig spärr, som signaleras med koden 429.
- En nyckel agerar bara inom ramen för sina behörigheter: en förfrågan utanför dem nekas.
- Att starta ett workflow via API:et förbrukar krediter precis som från appen.
- För att bli meddelad när en körning är klar utan att fråga API:et om och om igen, använd webhooks.
- En fråga? Gå via kontakta oss eller knappen Report a bug i appen, med förfrågnings-ID:t.