Przejdź do treści
ShopentlyLearn
Polski

Uwierzytelnianie

Utwórz klucz API

Do połączenia aplikacji ze sklepem potrzebujesz klucza API. W panelu administracyjnym wybierz dla niego uprawnienia, czyli określ, jakie dane aplikacja może odczytywać i co może zmieniać w sklepie.

Możesz też wskazać adresy IP, z których aplikacja będzie łączyć się z API. Jeśli je podasz, z klucza będzie można korzystać tylko z tych adresów. Następnie utwórz klucz API.

Pobierz token dostępu

Token dostępu pozwala wysyłać żądania bez przekazywania klucza API w każdym żądaniu. Możesz go anulować, gdy nie jest już potrzebny.

Razem z tokenem otrzymasz listę uprawnień oraz limity zapytań API obowiązujące w Twoim sklepie.

POST/api/v1/auth/token

Żądanie cURL 

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

Odpowiedź 

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

Wysyłaj żądania API

Używaj otrzymanego tokenu, gdy wysyłasz żądania do API. Nie przekraczaj limitów zapytań obowiązujących w Twoim sklepie. Dostęp do poszczególnych operacji zależy również od uprawnień dostępnych w Twoim planie.

Jeśli potrzebujesz wybrać język lub rynek dla swoich żądań, pobierz kontekst sklepu. Otrzymasz listę dostępnych języków i rynków wraz z ich oznaczeniami.

Anuluj token

Anulowanie tokenu jest opcjonalne. Jeśli korzystasz z niego tylko do jednorazowego zadania, zalecamy anulować go po zakończeniu pracy. Bez ręcznego anulowania token będzie działał do końca ustawionego czasu ważności, a potem nie będzie można go już użyć.

POST/api/v1/auth/revoke

Żądanie cURL 

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

Odpowiedź 

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