Ga naar de inhoud
ShopentlyLearn
Nederlands

Authenticatie

Een API-sleutel maken

Je hebt een API-sleutel nodig om je applicatie met de winkel te verbinden. Kies in het beheerpaneel de rechten om vast te leggen welke gegevens de applicatie mag lezen en wat ze mag wijzigen.

Je kunt ook de IP-adressen opgeven waarmee de applicatie verbinding maakt met de API. Als je die opgeeft, werkt de sleutel alleen vanaf die adressen. Maak daarna de API-sleutel aan.

Vraag een toegangstoken aan

Met een toegangstoken kun je verzoeken versturen zonder de API-sleutel in elk verzoek mee te sturen. Je kunt het token intrekken wanneer je het niet meer nodig hebt.

Bij het token ontvang je de rechten en API-aanvraaglimieten van je winkel. Door

POST/api/v1/auth/token

cURL-aanvraag 

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

Antwoord 

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

Verstuur API-aanvragen

Gebruik het ontvangen token voor je API-aanvragen. Houd je aan de aanvraaglimieten van je winkel. De toegang tot elke bewerking hangt ook af van de rechten van je abonnement.

Wil je een taal of markt voor je verzoeken kiezen, haal dan de winkelcontext op. Je ontvangt de beschikbare talen en markten met hun codes en identificaties.

Trek het token in

Een token intrekken is optioneel. Gebruik je het voor één taak, dan raden we aan het na afloop in te trekken. Zonder handmatige intrekking blijft het token geldig tot de ingestelde geldigheidsduur afloopt. Daarna kun je het niet meer gebruiken.

POST/api/v1/auth/revoke

cURL-aanvraag 

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

Antwoord 

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