Преминете към съдържанието
ShopentlyLearn
Български

Удостоверяване

Създайте API ключ

За да свържете приложението си с магазина, ви е нужен API ключ. В административния панел изберете правата му, които определят какви данни приложението може да чете и какво може да променя.

Можете да посочите и IP адресите, от които приложението ще се свързва с API. Ако ги въведете, ключът ще може да се използва само от тези адреси. След това създайте API ключа.

Получи токен за достъп

Токенът за достъп позволява да изпращате заявки, без да предавате API ключа във всяка заявка. Можете да го отмените, когато вече не ви е нужен.

Заедно с токена получаваш разрешенията и ограниченията за API заявките на магазина си.

POST/api/v1/auth/token

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

Отговор 

{
  "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 заявки

Използвай получения токен, когато изпращаш API заявки. Спазвай ограниченията на заявките за магазина. Достъпът до отделните операции зависи и от разрешенията на твоя план.

Ако трябва да изберете език или пазар за заявките си, изтеглете контекста на магазина. Ще получите наличните езици и пазари с техните кодове и идентификатори.

Отмени токена

Отмяната на токена не е задължителна. Ако го използвате за еднократна задача, препоръчваме да го отмените след приключването ѝ. Без ръчна отмяна токенът остава валиден до края на зададения срок. След това не може да се използва.

POST/api/v1/auth/revoke

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

Отговор 

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