Autentisering

1Opprett en API-nøkkel

Du trenger en API-nøkkel for å koble applikasjonen til butikken. Velg rettighetene i administrasjonspanelet for å angi hvilke data applikasjonen kan lese, og hva den kan endre.

Du kan også angi IP-adressene applikasjonen skal bruke for å koble til API-et. Hvis du oppgir dem, kan nøkkelen bare brukes fra disse adressene. Opprett deretter API-nøkkelen.

2Hent et tilgangstoken

Med et tilgangstoken kan du sende forespørsler uten å sende API-nøkkelen i hver forespørsel. Du kan tilbakekalle tokenet når du ikke trenger det lenger.

Sammen med tokenet får du butikkens tillatelser og grenser for API-kall. Når du

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --url https://shop.onshopently.com/api/v1/auth/token \
  --header 'Authorization: ApiKey EXAMPLE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{"ttl_seconds":1800}'

{
  "data": {
    "access_token": "EXAMPLE_ACCESS_TOKEN",
    "expires_at": "2026-01-01T12:15:00Z",
    "expires_in": 1800,
    "permissions": [
      "orders.order:read"
    ],
    "rate_limits": {
      "auth_per_minute": 1,
      "read_per_minute": 2,
      "write_per_minute": 15
    },
    "token_type": "Bearer",
    "warnings": []
  },
  "meta": {
    "request_id": "example"
  }
}

3Send API-kall

Bruk tokenet du har mottatt når du sender API-kall. Hold deg innenfor butikkens grenser for API-kall. Tilgangen til hver operasjon avhenger også av tillatelsene i abonnementet ditt.

Hvis du trenger å velge språk eller marked for forespørslene dine, henter du butikkens kontekst. Du får de tilgjengelige språkene og markedene med kodene og identifikatorene deres.

4Tilbakekall tokenet

Det er valgfritt å tilbakekalle et token. Bruker du det til en engangsoppgave, anbefaler vi å tilbakekalle det når oppgaven er ferdig. Hvis du ikke tilbakekaller tokenet manuelt, er det gyldig til den angitte varigheten utløper. Deretter kan det ikke lenger brukes.

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --url https://shop.onshopently.com/api/v1/auth/revoke \
  --header 'Authorization: ApiKey EXAMPLE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{"access_token":"EXAMPLE_ACCESS_TOKEN"}'

{
  "data": {
    "revoked": true
  },
  "meta": {
    "request_id": "example-request"
  }
}