De publieke API gebruiken

De publieke API van Upsellr geeft vanuit je eigen tools toegang tot je master data, je producten, je bronnen en je workflows. Ze is inbegrepen in het Enterprise-abonnement.

De essentie

• Basisadres: https://api.upsellr.io/v2
• Authenticatie: elke request bevat de header Authorization met de waarde Bearer gevolgd door je sleutel. Zie API-sleutels aanmaken en beheren.
• Documentatie: de volledige referentie, met voorbeelden, staat op docs.upsellr.io.

Alleen aanroepen vanaf een server

De API roep je aan vanaf een server, nooit vanuit een browser: ze antwoordt niet op requests die door een webpagina worden verstuurd. Zo voorkom je ook dat je sleutel zichtbaar wordt in de code van een pagina.

De rate limits

De limieten gelden voor de hele organisatie, alle sleutels samen.

Type request	Per minuut	Burst
Lezen	200	30
Schrijven	60	10
Zwaar schrijven: producten aanmaken, bestand uploaden, workflow starten	20	5
Producten zoeken en lezen	60	5

Daarboven antwoordt de API met code 429 en een header Retry-After die in seconden aangeeft wanneer je het opnieuw kunt proberen.

Request-ID

Elk antwoord bevat een header X-Request-Id. Mislukt een request onverwacht, noteer dan deze ID en geef haar door aan de support: daarmee kan je aanroep precies worden teruggevonden.

Goed om te weten

• Een sleutel die beperkt is tot bepaalde IP-adressen of User-Agents, wordt geweigerd vanaf elke andere herkomst.
• Te veel requests met een ongeldige sleutel vanaf hetzelfde adres leiden tot een tijdelijke blokkering, gemeld met code 429.
• Een sleutel werkt alleen binnen de grenzen van haar scopes: een request buiten de scope wordt geweigerd.
• Een workflow starten via de API verbruikt credits zoals vanuit de applicatie.
• Om op de hoogte te worden gebracht van het einde van een uitvoering zonder de API steeds opnieuw te bevragen, gebruik je de webhooks.
• Een vraag? Gebruik neem contact met ons op of de knop Report a bug in de app, met de request-ID.