Preskočiť na obsah
ShopentlyLearn
Slovenčina

Overovanie

Vytvorte kľúč API

Na prepojenie aplikácie s obchodom potrebujete kľúč API. V administračnom paneli vyberte jeho oprávnenia, ktoré určujú, aké údaje môže aplikácia čítať a čo môže v obchode meniť.

Môžete tiež zadať IP adresy, z ktorých bude aplikácia pristupovať k API. Ak ich zadáte, kľúč sa bude dať používať iba z týchto adries. Potom vytvorte kľúč API.

Získaj prístupový token

Prístupový token umožňuje odosielať požiadavky bez posielania kľúča API v každej požiadavke. Keď ho už nepotrebujete, môžete ho zrušiť.

Spolu s tokenom získaš oprávnenia a limity požiadaviek API svojho obchodu.

POST/api/v1/auth/token

Požiadavka 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}'

Odpoveď 

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

Posielaj požiadavky API

Pri posielaní požiadaviek API používaj získaný token. Neprekračuj limity požiadaviek svojho obchodu. Prístup k jednotlivým operáciám závisí aj od oprávnení tvojho programu.

Ak potrebujete pre požiadavky vybrať jazyk alebo trh, načítajte kontext obchodu. Získate dostupné jazyky a trhy spolu s ich kódmi a identifikátormi.

Zruš token

Zrušenie tokenu je voliteľné. Ak ho používate na jednorazovú úlohu, odporúčame ho po dokončení zrušiť. Bez ručného zrušenia zostane token platný do konca nastaveného času. Potom ho už nebude možné použiť.

POST/api/v1/auth/revoke

Požiadavka 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"}'

Odpoveď 

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