Перейти до вмісту
ShopentlyLearn

Схеми даних: Автентифікація

Схеми даних: Автентифікація. Поля, типи й обмеження даних, які API приймає або повертає.

Схеми даних

Отримати · Токен — Автентифікація — Відповідь

ApiResponse_TokenData_ · Поля, типи й обмеження даних, які API приймає або повертає.
dataTokenData Обов’язкове

Приклад відповіді · TokenData.

Приклад: {"access_token":"EXAMPLE_ACCESS_TOKEN","expires_at":"2026-01-01T12:00:00Z","expires_in":900,"rate_limits":{"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10},"token_type":"Bearer"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Обов’язкове

Метадані відповіді.

Приклад: {"request_id":"example"}

Додаткові поля: Ні

Отримати · Токен — Автентифікація — Відповідь

TokenData · Поля, типи й обмеження даних, які API приймає або повертає.
access_tokenРядокОбов’язкове

Токен для заголовка Authorization: Bearer. Перед запуском окремого прикладу задайте SHOPENTLY_ACCESS_TOKEN.

Приклад: "EXAMPLE_ACCESS_TOKEN"
expires_atРядокОбов’язкове

Час завершення дії в UTC. Поточні обмеження доступу можуть заблокувати токен раніше.

format: "date-time"
Приклад: "2026-01-01T12:00:00Z"
expires_inЦіле числоНеобов’язкове

900 секунд, тобто 15 хвилин від моменту видачі. Виконання запитів не подовжує строк дії.

За замовчуванням: 900Приклад: 900
rate_limitsTokenRateLimitsData Обов’язкове

Engine ≥ 4.143.0. Кожна відповідь із токеном містить data.rate_limits з політики магазину на момент видачі. Усі ключі спільно використовують ці ліміти; новий токен їх не скидає. Зміна плану може діяти до завершення строку токена.

Приклад: {"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10}
token_typeРядокНеобов’язкове

Bearer. Схема автентифікації для повернутого токена.

const: "Bearer"
За замовчуванням: "Bearer"Приклад: "Bearer"

Додаткові поля: Ні

Обмеження частоти запитів

TokenRateLimitsData · Engine ≥ 4.143.0. Кожна відповідь із токеном містить data.rate_limits з політики магазину на момент видачі. Усі ключі спільно використовують ці ліміти; новий токен їх не скидає. Зміна плану може діяти до завершення строку токена. Нуль означає недоступність, а не відсутність обмежень.
auth_per_minuteЦіле числоОбов’язкове

Запити токена за хвилину, включно з невдалими спробами автентифікації.

minimum: 0maximum: 1000000
Приклад: 10
read_per_minuteЦіле числоОбов’язкове

Запити читання за хвилину.

minimum: 0maximum: 1000000
Приклад: 60
write_per_minuteЦіле числоОбов’язкове

Запити запису за хвилину; це значення не надає прав запису.

minimum: 0maximum: 1000000
Приклад: 10

Додаткові поля: Ні

Отримати · Токен — Автентифікація — Тіло запиту

TokenRequest · Поля, типи й обмеження даних, які API приймає або повертає.
Об’єктДодаткові поля: Ні

Додаткові поля: Ні