Zum Inhalt springen
ShopentlyLearn
Deutsch

Authentifizierung

API-Schlüssel erstellen

Um deine Anwendung mit dem Shop zu verbinden, brauchst du einen API-Schlüssel. Wähle im Adminbereich seine Berechtigungen aus. Damit legst du fest, welche Daten die Anwendung lesen und was sie im Shop ändern darf.

Du kannst auch die IP-Adressen angeben, von denen deine Anwendung auf die API zugreift. Wenn du sie angibst, lässt sich der Schlüssel nur von diesen Adressen aus verwenden. Erstelle anschließend den API-Schlüssel.

Zugriffstoken abrufen

Mit einem Zugriffstoken kannst du Anfragen senden, ohne den API-Schlüssel in jeder Anfrage zu übermitteln. Du kannst den Token widerrufen, wenn du ihn nicht mehr brauchst.

Mit dem Token erhältst du die Berechtigungen und API-Anfragelimits deines Shops. Wenn du

POST/api/v1/auth/token

cURL-Anfrage 

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

Antwort 

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

API-Anfragen senden

Verwende den erhaltenen Token für deine API-Anfragen. Halte die Anfragelimits deines Shops ein. Welche Operationen du nutzen kannst, hängt auch von den Berechtigungen deines Tarifs ab.

Wenn du für deine Anfragen eine Sprache oder einen Markt auswählen möchtest, rufe den Shop-Kontext ab. Du erhältst die verfügbaren Sprachen und Märkte mit ihren Codes und Kennungen.

Token widerrufen

Das Widerrufen eines Tokens ist optional. Wenn du es nur für eine einmalige Aufgabe verwendest, empfehlen wir, es danach zu widerrufen. Ohne manuellen Widerruf bleibt das Token bis zum Ende seiner festgelegten Gültigkeitsdauer nutzbar. Danach kannst du es nicht mehr verwenden.

POST/api/v1/auth/revoke

cURL-Anfrage 

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

Antwort 

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