Datu shēmas: Autentifikācija

dataTokenData Obligāts

Atbildes piemērs · TokenData.

Piemērs: {"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 Obligāts

Atbildes metadati.

Piemērs: {"request_id":"example"}

Papildu lauki: Nē

dataTokenRevokedData Obligāts

Atbildes piemērs · TokenRevokedData.

Piemērs: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligāts

Atbildes metadati.

Piemērs: {"request_id":"example-request"}

Papildu lauki: Nē

access_tokenVirkneObligāts

Pilnvara galvenei Authorization: Bearer. Pirms atsevišķā piemēra izpildes iestatiet SHOPENTLY_ACCESS_TOKEN.

Piemērs: "EXAMPLE_ACCESS_TOKEN"

expires_atVirkneObligāts

Derīguma beigu laiks UTC. Pašreizējie piekļuves ierobežojumi var bloķēt pilnvaru agrāk.

format: "date-time"

Piemērs: "2026-01-01T12:15:00Z"

expires_inVesels skaitlisObligāts

Faktiskais derīguma laiks sekundēs; šajā piemērā pieprasa 1800. Pieprasījumi to nepagarina. expires_at norāda beigu laiku UTC.

minimum: 300maximum: 3600

Piemērs: 1800

permissionsMasīvs <Virkne> Obligāts

permissions rāda pašreizējās spēkā esošās tiesības: atslēgas, tās autora un veikala plāna tiesību šķēlumu, ieskaitot aktīvos papildinājumus. Piekļuvi pārbauda katrā pieprasījumā.

Piemērs: ["orders.order:read"]

rate_limitsTokenRateLimitsData Obligāts

Engine ≥ 4.143.0. Katra tokena atbilde ietver data.rate_limits no veikala politikas izdošanas brīdī. Visas atslēgas koplieto šos limitus; jauns tokens tos neatiestata. Plāna maiņa var stāties spēkā pirms tokena derīguma beigām.

Piemērs: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_typeVirkneNeobligāts

Bearer. Atgrieztā marķiera autentifikācijas shēma.

const: "Bearer"

Noklusējums: "Bearer"Piemērs: "Bearer"

warningsMasīvs <TokenLifetimeWarning > Obligāts

Vesels skaitlis ārpus diapazona iestata 900 sekundes un atgriež warnings ar token.ttl_out_of_range un documentation_url uz learn.shopently.com. Izlaists lauks nerada brīdinājumu; nepareizs tips atgriež 422.

Piemērs: []

Papildu lauki: Nē

applied_secondsVesels skaitlisNeobligāts

900 s (15 min)

Noklusējums: 900

codeVirkneNeobligāts

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Noklusējums: "token.ttl_out_of_range"

documentation_urlVirkneNeobligāts

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

Noklusējums: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"

fieldVirkneNeobligāts

ttl_seconds

const: "ttl_seconds"

Noklusējums: "ttl_seconds"

max_secondsVesels skaitlisNeobligāts

3600 s (60 min)

Noklusējums: 3600

messageVirkneNeobligāts

Vesels skaitlis ārpus diapazona iestata 900 sekundes un atgriež warnings ar token.ttl_out_of_range un documentation_url uz learn.shopently.com. Izlaists lauks nerada brīdinājumu; nepareizs tips atgriež 422.

Noklusējums: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."

min_secondsVesels skaitlisNeobligāts

300 s (5 min)

Noklusējums: 300

Papildu lauki: Nē

auth_per_minuteVesels skaitlisObligāts

Izdošanas un atsaukšanas pieprasījumi minūtē, ieskaitot neveiksmīgu autentifikāciju. Abas darbības koplieto auth ierobežojumu.

minimum: 0maximum: 1000000

Piemērs: 1

read_per_minuteVesels skaitlisObligāts

Lasīšanas pieprasījumi minūtē.

minimum: 0maximum: 1000000

Piemērs: 2

write_per_minuteVesels skaitlisObligāts

Rakstīšanas pieprasījumi minūtē; šī vērtība nepiešķir rakstīšanas tiesības.

minimum: 0maximum: 1000000

Piemērs: 15

Papildu lauki: Nē

ttl_secondsVesels skaitlisNeobligāts

Neobligāts vesels skaitlis ttl_seconds: 300–3600 sekundes (5–60 minūtes). Ja lauka nav, noklusējums ir 900 sekundes (15 minūtes).

Noklusējums: 900Piemērs: 1800

Papildu lauki: Nē

access_tokenVirkneObligāts

Sūtiet POST /api/v1/auth/revoke ar izdevēja atslēgu galvenē Authorization: ApiKey un pilnvaru JSON laukā access_token. Pēc veiksmīgas darbības nākamā izmantošana atgriež 401. Atkārtota, nezināma vai sveša pilnvara saņem to pašu revoked: true; citu atslēgu pilnvaras netiek dzēstas.

minLength: 1maxLength: 256

Piemērs: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Papildu lauki: Nē

revokedLoģiska vērtībaNeobligāts

Sūtiet POST /api/v1/auth/revoke ar izdevēja atslēgu galvenē Authorization: ApiKey un pilnvaru JSON laukā access_token. Pēc veiksmīgas darbības nākamā izmantošana atgriež 401. Atkārtota, nezināma vai sveša pilnvara saņem to pašu revoked: true; citu atslēgu pilnvaras netiek dzēstas.

const: true

Noklusējums: truePiemērs: true

Papildu lauki: Nē