Ga naar de inhoud
ShopentlyLearn

Gegevensschema’s: Authenticatie

Gegevensschema’s: Authenticatie. Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

Gegevensschema’s

Ophalen · Token — Authenticatie — Antwoord

ApiResponse_TokenData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
dataTokenData Verplicht

Voorbeeldantwoord · TokenData.

Voorbeeld: {"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 Verplicht

Metadata van het antwoord.

Voorbeeld: {"request_id":"example"}

Aanvullende velden: Nee

Ophalen · Token — Authenticatie — Antwoord

TokenData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
access_tokenTekenreeksVerplicht

Token voor de header Authorization: Bearer. Stel SHOPENTLY_ACCESS_TOKEN in voordat je het losse voorbeeld uitvoert.

Voorbeeld: "EXAMPLE_ACCESS_TOKEN"
expires_atTekenreeksVerplicht

Vervaltijd in UTC. Actuele toegangsbeperkingen kunnen het token eerder blokkeren.

format: "date-time"
Voorbeeld: "2026-01-01T12:00:00Z"
expires_inGeheel getalOptioneel

900 seconden, dus 15 minuten vanaf uitgifte. Verzoeken verlengen de geldigheid niet.

Standaard: 900Voorbeeld: 900
rate_limitsTokenRateLimitsData Verplicht

Engine ≥ 4.143.0. Elke tokenrespons bevat data.rate_limits uit het winkelbeleid op het moment van uitgifte. Alle sleutels delen deze budgetten; een nieuw token zet ze niet terug. Een abonnementswijziging kan gelden voordat het token verloopt.

Voorbeeld: {"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10}
token_typeTekenreeksOptioneel

Bearer. Authenticatieschema voor het teruggegeven token.

const: "Bearer"
Standaard: "Bearer"Voorbeeld: "Bearer"

Aanvullende velden: Nee

Verzoeklimieten

TokenRateLimitsData · Engine ≥ 4.143.0. Elke tokenrespons bevat data.rate_limits uit het winkelbeleid op het moment van uitgifte. Alle sleutels delen deze budgetten; een nieuw token zet ze niet terug. Een abonnementswijziging kan gelden voordat het token verloopt. Nul betekent niet beschikbaar, niet onbeperkt.
auth_per_minuteGeheel getalVerplicht

Tokenverzoeken per minuut, inclusief mislukte authenticatiepogingen.

minimum: 0maximum: 1000000
Voorbeeld: 10
read_per_minuteGeheel getalVerplicht

Leesverzoeken per minuut.

minimum: 0maximum: 1000000
Voorbeeld: 60
write_per_minuteGeheel getalVerplicht

Schrijfverzoeken per minuut; deze waarde verleent geen schrijfrechten.

minimum: 0maximum: 1000000
Voorbeeld: 10

Aanvullende velden: Nee

Ophalen · Token — Authenticatie — Verzoekinhoud

TokenRequest · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
ObjectAanvullende velden: Nee

Aanvullende velden: Nee