Gå til indhold
ShopentlyLearn

Dataskemaer: Godkendelse

Dataskemaer: Godkendelse. Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

Dataskemaer

Hent · Token — Godkendelse — Svar

ApiResponse_TokenData_ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
dataTokenData Obligatorisk

Eksempel på svar · TokenData.

Eksempel: {"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 Obligatorisk

Svarmetadata.

Eksempel: {"request_id":"example"}

Yderligere felter: Nej

Hent · Token — Godkendelse — Svar

TokenData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
access_tokenStrengObligatorisk

Token til headeren Authorization: Bearer. Indstil SHOPENTLY_ACCESS_TOKEN, før du kører det separate eksempel.

Eksempel: "EXAMPLE_ACCESS_TOKEN"
expires_atStrengObligatorisk

Udløbstidspunkt i UTC. Aktuelle adgangsbegrænsninger kan blokere tokenet tidligere.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
expires_inHeltalValgfrit

900 sekunder, altså 15 minutter fra udstedelsen. Kald forlænger ikke gyldigheden.

Standard: 900Eksempel: 900
rate_limitsTokenRateLimitsData Obligatorisk

Engine ≥ 4.143.0. Hvert tokensvar indeholder data.rate_limits fra butikkens politik ved udstedelsen. Alle nøgler deler disse budgetter; en ny token nulstiller dem ikke. En abonnementsændring kan gælde, før tokenen udløber.

Eksempel: {"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10}
token_typeStrengValgfrit

Bearer. Godkendelsesmetode for det returnerede token.

const: "Bearer"
Standard: "Bearer"Eksempel: "Bearer"

Yderligere felter: Nej

Forespørgselsgrænser

TokenRateLimitsData · Engine ≥ 4.143.0. Hvert tokensvar indeholder data.rate_limits fra butikkens politik ved udstedelsen. Alle nøgler deler disse budgetter; en ny token nulstiller dem ikke. En abonnementsændring kan gælde, før tokenen udløber. Nul betyder utilgængelig, ikke ubegrænset.
auth_per_minuteHeltalObligatorisk

Tokenanmodninger pr. minut, inklusive mislykkede godkendelsesforsøg.

minimum: 0maximum: 1000000
Eksempel: 10
read_per_minuteHeltalObligatorisk

Læseanmodninger pr. minut.

minimum: 0maximum: 1000000
Eksempel: 60
write_per_minuteHeltalObligatorisk

Skriveanmodninger pr. minut; værdien giver ikke skriverettigheder.

minimum: 0maximum: 1000000
Eksempel: 10

Yderligere felter: Nej

Hent · Token — Godkendelse — Forespørgselsindhold

TokenRequest · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
ObjektYderligere felter: Nej

Yderligere felter: Nej