Pāriet uz saturu
ShopentlyLearn

Datu shēmas: Autentifikācija

Datu shēmas: Autentifikācija. API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

Datu shēmas

Iegūt · Piekļuves tokens — Autentifikācija — Atbilde

ApiResponse_TokenData_ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
dataTokenData Obligāts

Atbildes piemērs · TokenData.

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

Atbildes metadati.

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

Papildu lauki: Nē

Iegūt · Piekļuves tokens — Autentifikācija — Atbilde

TokenData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
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:00:00Z"
expires_inVesels skaitlisNeobligāts

900 sekundes jeb 15 minūtes no izdošanas. Pieprasījumi nepagarina derīgumu.

Noklusējums: 900Piemērs: 900
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":10,"read_per_minute":60,"write_per_minute":10}
token_typeVirkneNeobligāts

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

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

Papildu lauki: Nē

Pieprasījumu biežuma ierobežojumi

TokenRateLimitsData · 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. Nulle nozīmē nepieejamību, nevis neierobežotu lietošanu.
auth_per_minuteVesels skaitlisObligāts

Tokena pieprasījumi minūtē, ieskaitot neveiksmīgus autentifikācijas mēģinājumus.

minimum: 0maximum: 1000000
Piemērs: 10
read_per_minuteVesels skaitlisObligāts

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

minimum: 0maximum: 1000000
Piemērs: 60
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: 10

Papildu lauki: Nē

Iegūt · Piekļuves tokens — Autentifikācija — Pieprasījuma saturs

TokenRequest · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
ObjektsPapildu lauki: Nē

Papildu lauki: Nē