Ověřování

1Vytvořte klíč API

K propojení aplikace s obchodem potřebujete klíč API. V administračním panelu vyberte jeho oprávnění, která určují, jaká data může aplikace číst a co může v obchodě měnit.

Můžete také zadat IP adresy, ze kterých bude aplikace přistupovat k API. Pokud je zadáte, klíč bude možné používat pouze z těchto adres. Poté klíč API vytvořte.

2Získej přístupový token

Přístupový token umožňuje odesílat požadavky bez předávání klíče API v každém požadavku. Pokud ho už nepotřebujete, můžete ho zneplatnit.

Spolu s tokenem získáš oprávnění a limity požadavků API svého obchodu.

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

3Odesílej požadavky API

Při odesílání požadavků API používej získaný token. Nepřekračuj limity požadavků svého obchodu. Přístup k jednotlivým operacím závisí také na oprávněních tvého tarifu.

Pokud potřebujete pro požadavky vybrat jazyk nebo trh, načtěte kontext obchodu. Získáte dostupné jazyky a trhy včetně jejich kódů a identifikátorů.

4Zruš token

Zrušení tokenu je volitelné. Pokud ho používáte pro jednorázový úkol, doporučujeme ho po dokončení zrušit. Bez ručního zrušení zůstane token platný do konce nastavené doby. Poté ho již nebude možné použít.

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