Схеми на данните: Удостоверяване

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

Допълнителни полета: Не