Перейти до вмісту
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"
  }
}