Dataskjemaer: Autentisering

Dataskjemaer: Autentisering. Felter, typer og begrensninger for data som API-et mottar eller returnerer.

Dataskjemaer

Hent · Token — Autentisering — Svar

ApiResponse_TokenData_ · Felter, typer og begrensninger for data som API-et mottar 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"}

Ytterligere felt: Nei

Hent · Token — Autentisering — Svar

TokenData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

access_tokenStrengObligatorisk: Token for headeren Authorization: Bearer. Angi SHOPENTLY_ACCESS_TOKEN før du kjører det separate eksemplet.

Eksempel: "EXAMPLE_ACCESS_TOKEN"
expires_atStrengObligatorisk: Utløpstidspunkt i UTC. Gjeldende tilgangsbegrensninger kan blokkere tokenet tidligere.

format: "date-time"

Eksempel: "2026-01-01T12:00:00Z"
expires_inHeltallValgfritt: 900 sekunder, altså 15 minutter fra utstedelsen. Forespørsler forlenger ikke gyldigheten.

Standard: 900Eksempel: 900
rate_limitsTokenRateLimitsData Obligatorisk: Engine ≥ 4.143.0. Hvert tokensvar inneholder data.rate_limits fra butikkens gjeldende policy ved utstedelsen. Alle nøkler deler disse budsjettene; et nytt token nullstiller dem ikke. En abonnementsendring kan gjelde før tokenet utløper.

Eksempel: {"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10}
token_typeStrengValgfritt: Bearer. Autentiseringsmetode for det returnerte tokenet.

const: "Bearer"

Standard: "Bearer"Eksempel: "Bearer"

Ytterligere felt: Nei

Forespørselsgrenser

TokenRateLimitsData · Engine ≥ 4.143.0. Hvert tokensvar inneholder data.rate_limits fra butikkens gjeldende policy ved utstedelsen. Alle nøkler deler disse budsjettene; et nytt token nullstiller dem ikke. En abonnementsendring kan gjelde før tokenet utløper. Null betyr utilgjengelig, ikke ubegrenset.

auth_per_minuteHeltallObligatorisk: Tokenforespørsler per minutt, inkludert mislykkede autentiseringsforsøk.

minimum: 0maximum: 1000000

Eksempel: 10
read_per_minuteHeltallObligatorisk: Leseforespørsler per minutt.

minimum: 0maximum: 1000000

Eksempel: 60
write_per_minuteHeltallObligatorisk: Skriveforespørsler per minutt; verdien gir ikke skrivetilgang.

minimum: 0maximum: 1000000

Eksempel: 10

Ytterligere felt: Nei

Hent · Token — Autentisering — Forespørselsinnhold

TokenRequest · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

ObjektYtterligere felt: Nei

Ytterligere felt: Nei