Brug den offentlige API

Basisadresse, godkendelse, hastighedsgrænser og request-id: det vigtigste for at koble dine værktøjer til Upsellr.

Upsellrs offentlige API giver adgang til din master data, dine produkter, dine kilder og dine workflows fra dine egne værktøjer. Den er inkluderet i abonnementet Enterprise.

Det vigtigste

  • Basisadresse: https://api.upsellr.io/v2
  • Godkendelse: hver forespørgsel har headeren Authorization med værdien Bearer efterfulgt af din nøgle. Se opret og administrer API-nøgler.
  • Dokumentation: den fulde reference med eksempler er offentliggjort på docs.upsellr.io.

Kun kald fra en server

API’en kaldes fra en server, aldrig fra en browser: den svarer ikke på forespørgsler, der sendes fra en webside. Det forhindrer også, at din nøgle bliver eksponeret i en sides kode.

Hastighedsgrænserne

Grænserne gælder for hele organisationen, alle nøgler tilsammen.

Type forespørgsel Pr. minut Burst
Læsninger 200 30
Skrivninger 60 10
Tunge skrivninger: oprettelse af produkter, upload af fil, start af workflow 20 5
Søgning og læsning af produkter 60 5

Ud over det svarer API’en med kode 429 og en header Retry-After, der angiver i sekunder, hvornår du kan prøve igen.

Request-id

Hvert svar har en header X-Request-Id. Mislykkes en forespørgsel uventet, så notér dette id, og send det til support: det gør det muligt at finde præcis dit kald.

Godt at vide

  • En nøgle, der er begrænset til bestemte IP-adresser eller User-Agents, afvises fra enhver anden oprindelse.
  • For mange forespørgsler med en ugyldig nøgle fra samme adresse medfører en midlertidig blokering, der meldes med kode 429.
  • En nøgle virker kun inden for sine scopes: en forespørgsel uden for scope afvises.
  • At starte et workflow via API’en bruger kreditter på samme måde som fra appen.
  • Vil du have besked, når en kørsel er færdig, uden at spørge API’en igen og igen, så brug webhooks.
  • Har du et spørgsmål? Brug kontakt os eller knappen Report a bug i appen sammen med request-id’et.

Kan du ikke finde svaret?

Kontakt os