Hoppa till innehållet
ShopentlyLearn
Svenska

Autentisering

Skapa en API-nyckel

Du behöver en API-nyckel för att ansluta din applikation till butiken. Välj behörigheter i administrationspanelen för att ange vilka uppgifter applikationen får läsa och vad den får ändra.

Du kan också ange de IP-adresser som applikationen ska använda för att ansluta till API:et. Om du anger dem kan nyckeln bara användas från dessa adresser. Skapa sedan API-nyckeln.

Hämta en åtkomsttoken

Med en åtkomsttoken kan du skicka förfrågningar utan att skicka API-nyckeln i varje förfrågan. Du kan återkalla token när du inte längre behöver den.

Tillsammans med token får du butikens behörigheter och gränser för API-anrop. När du

POST/api/v1/auth/token

cURL-begäran 

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

Svar 

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

Skicka API-anrop

Använd den token du fått när du skickar API-anrop. Håll dig inom butikens gränser för API-anrop. Tillgången till varje åtgärd beror också på behörigheterna i din plan.

Om du behöver välja språk eller marknad för dina förfrågningar hämtar du butikens kontext. Du får de tillgängliga språken och marknaderna med deras koder och identifierare.

Återkalla token

Det är frivilligt att återkalla en token. Om du använder den för en engångsuppgift rekommenderar vi att du återkallar den när uppgiften är klar. Om du inte återkallar token manuellt gäller den tills den angivna giltighetstiden tar slut. Därefter kan den inte längre användas.

POST/api/v1/auth/revoke

cURL-begäran 

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

Svar 

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