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

dataTokenData Обов’язкове

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

Приклад: {"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":[]}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Обов’язкове

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

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

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

dataTokenRevokedData Обов’язкове

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

Приклад: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Обов’язкове

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

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

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

access_tokenРядокОбов’язкове

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

Приклад: "EXAMPLE_ACCESS_TOKEN"

expires_atРядокОбов’язкове

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

format: "date-time"

Приклад: "2026-01-01T12:15:00Z"

expires_inЦіле числоОбов’язкове

Фактичний строк дії в секундах; цей приклад запитує 1800. Запити не подовжують його. expires_at — момент завершення дії в UTC.

minimum: 300maximum: 3600

Приклад: 1800

permissionsМасив <Рядок> Обов’язкове

permissions містить поточні ефективні дозволи: перетин дозволів ключа, його автора та тарифу магазину, включно з активними додатками. Доступ перевіряється під час кожного запиту.

Приклад: ["orders.order:read"]

rate_limitsTokenRateLimitsData Обов’язкове

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

Приклад: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_typeРядокНеобов’язкове

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

const: "Bearer"

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

warningsМасив <TokenLifetimeWarning > Обов’язкове

Ціле число поза діапазоном встановлює 900 секунд і повертає warnings з token.ttl_out_of_range та documentation_url на learn.shopently.com. Відсутність поля не спричиняє попередження; хибний тип повертає 422.

Приклад: []

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

applied_secondsЦіле числоНеобов’язкове

900 s (15 min)

За замовчуванням: 900

codeРядокНеобов’язкове

token.ttl_out_of_range

const: "token.ttl_out_of_range"

За замовчуванням: "token.ttl_out_of_range"

documentation_urlРядокНеобов’язкове

https://learn.shopently.com/en/api/docs/authentication/#token-lifetime

За замовчуванням: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"

fieldРядокНеобов’язкове

ttl_seconds

const: "ttl_seconds"

За замовчуванням: "ttl_seconds"

max_secondsЦіле числоНеобов’язкове

3600 s (60 min)

За замовчуванням: 3600

messageРядокНеобов’язкове

Ціле число поза діапазоном встановлює 900 секунд і повертає warnings з token.ttl_out_of_range та documentation_url на learn.shopently.com. Відсутність поля не спричиняє попередження; хибний тип повертає 422.

За замовчуванням: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."

min_secondsЦіле числоНеобов’язкове

300 s (5 min)

За замовчуванням: 300

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

auth_per_minuteЦіле числоОбов’язкове

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

minimum: 0maximum: 1000000

Приклад: 1

read_per_minuteЦіле числоОбов’язкове

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

minimum: 0maximum: 1000000

Приклад: 2

write_per_minuteЦіле числоОбов’язкове

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

minimum: 0maximum: 1000000

Приклад: 15

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

ttl_secondsЦіле числоНеобов’язкове

Необов’язкове ціле число ttl_seconds: 300–3600 секунд (5–60 хвилин). Без поля діє типове значення 900 секунд (15 хвилин).

За замовчуванням: 900Приклад: 1800

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

access_tokenРядокОбов’язкове

Надішліть POST /api/v1/auth/revoke з ключем, що видав токен, у Authorization: ApiKey та токеном у полі JSON access_token. Після успіху наступне використання повертає 401. Повторний, невідомий чи чужий токен дає те саме revoked: true; токени інших ключів не видаляються.

minLength: 1maxLength: 256

Приклад: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

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

revokedЛогічне значенняНеобов’язкове

Надішліть POST /api/v1/auth/revoke з ключем, що видав токен, у Authorization: ApiKey та токеном у полі JSON access_token. Після успіху наступне використання повертає 401. Повторний, невідомий чи чужий токен дає те саме revoked: true; токени інших ключів не видаляються.

const: true

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

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