Godkendelse

1Opret en API-nøgle

Du skal bruge en API-nøgle for at forbinde din applikation med butikken. Vælg dens rettigheder i administrationspanelet for at angive, hvilke data applikationen må læse, og hvad den må ændre.

Du kan også angive de IP-adresser, som applikationen vil bruge til API’et. Hvis du angiver dem, kan nøglen kun bruges fra disse adresser. Opret derefter API-nøglen.

2Hent et adgangstoken

Med et adgangstoken kan du sende forespørgsler uden at sende API-nøglen i hver forespørgsel. Du kan tilbagekalde tokenet, når du ikke længere har brug for det.

Sammen med tokenet får du butikkens rettigheder og grænser for API-kald. 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-kald

Brug det modtagne token, når du sender API-kald. Overhold butikkens grænser for API-kald. Adgangen til de enkelte handlinger afhænger også af rettighederne i dit abonnement.

Hvis du skal vælge sprog eller marked til dine forespørgsler, skal du hente butikkens kontekst. Du får de tilgængelige sprog og markeder med deres koder og identifikatorer.

4Tilbagekald tokenet

Det er valgfrit at tilbagekalde et token. Bruger du det til en enkelt opgave, anbefaler vi at tilbagekalde det bagefter. Hvis du ikke tilbagekalder tokenet manuelt, er det gyldigt, indtil den angivne varighed udløber. Derefter kan det ikke længere bruges.

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"
  }
}