Ugrás a tartalomhoz
ShopentlyLearn
Magyar

Hitelesítés

API-kulcs létrehozása

Az alkalmazás és az áruház összekapcsolásához API-kulcsra van szükséged. Az adminisztrációs felületen válaszd ki a jogosultságokat, amelyek meghatározzák, milyen adatokat olvashat és mit módosíthat az alkalmazás.

Megadhatod azokat az IP-címeket is, amelyekről az alkalmazás eléri az API-t. Ha megadod őket, a kulcs csak ezekről a címekről használható. Ezután hozd létre az API-kulcsot.

Kérj hozzáférési tokent

A hozzáférési tokennel úgy küldhetsz kéréseket, hogy nem kell minden kérésben elküldened az API-kulcsot. A tokent visszavonhatod, ha már nincs rá szükséged.

A tokennel együtt megkapod az áruházad jogosultságait és API-kéréseinek korlátait.

POST/api/v1/auth/token

cURL-kérés 

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

Válasz 

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

Küldj API-kéréseket

Az API-kérésekhez használd a kapott tokent. Tartsd be az áruház kérési korlátait. Az egyes műveletek elérése a csomagod jogosultságaitól is függ.

Ha nyelvet vagy piacot szeretnél választani a kéréseidhez, kérd le az áruház kontextusát. Megkapod az elérhető nyelveket és piacokat, valamint a kódjaikat és azonosítóikat.

Vond vissza a tokent

A token visszavonása nem kötelező. Ha egyszeri feladathoz használod, a munka végén javasoljuk a visszavonását. Kézi visszavonás nélkül a token a beállított érvényességi idő végéig használható. Ezután már nem használható.

POST/api/v1/auth/revoke

cURL-kérés 

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

Válasz 

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