Gegevensschema’s: Authenticatie

dataTokenData Verplicht

Voorbeeldantwoord · TokenData.

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

Metadata van het antwoord.

Voorbeeld: {"request_id":"example"}

Aanvullende velden: Nee

dataTokenRevokedData Verplicht

Voorbeeldantwoord · TokenRevokedData.

Voorbeeld: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Verplicht

Metadata van het antwoord.

Voorbeeld: {"request_id":"example-request"}

Aanvullende velden: Nee

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:15:00Z"

expires_inGeheel getalVerplicht

Werkelijke geldigheidsduur in seconden; dit voorbeeld vraagt 1800. Verzoeken verlengen deze niet. expires_at is het vervaltijdstip in UTC.

minimum: 300maximum: 3600

Voorbeeld: 1800

permissionsArray <Tekenreeks> Verplicht

permissions toont de huidige effectieve rechten: de doorsnede van de rechten van de sleutel, de maker en het winkelabonnement, inclusief actieve addons. Elk verzoek controleert de toegang opnieuw.

Voorbeeld: ["orders.order:read"]

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":1,"read_per_minute":2,"write_per_minute":15}

token_typeTekenreeksOptioneel

Bearer. Authenticatieschema voor het teruggegeven token.

const: "Bearer"

Standaard: "Bearer"Voorbeeld: "Bearer"

warningsArray <TokenLifetimeWarning > Verplicht

Een geheel getal buiten het bereik past 900 seconden toe en retourneert warnings met token.ttl_out_of_range en documentation_url naar learn.shopently.com. Weglaten geeft geen waarschuwing; ongeldige typen geven 422.

Voorbeeld: []

Aanvullende velden: Nee

applied_secondsGeheel getalOptioneel

900 s (15 min)

Standaard: 900

codeTekenreeksOptioneel

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Standaard: "token.ttl_out_of_range"

documentation_urlTekenreeksOptioneel

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

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

fieldTekenreeksOptioneel

ttl_seconds

const: "ttl_seconds"

Standaard: "ttl_seconds"

max_secondsGeheel getalOptioneel

3600 s (60 min)

Standaard: 3600

messageTekenreeksOptioneel

Een geheel getal buiten het bereik past 900 seconden toe en retourneert warnings met token.ttl_out_of_range en documentation_url naar learn.shopently.com. Weglaten geeft geen waarschuwing; ongeldige typen geven 422.

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

min_secondsGeheel getalOptioneel

300 s (5 min)

Standaard: 300

Aanvullende velden: Nee

auth_per_minuteGeheel getalVerplicht

Verzoeken voor tokenuitgifte en intrekking per minuut, inclusief mislukte authenticatie. Beide delen het auth-budget.

minimum: 0maximum: 1000000

Voorbeeld: 1

read_per_minuteGeheel getalVerplicht

Leesverzoeken per minuut.

minimum: 0maximum: 1000000

Voorbeeld: 2

write_per_minuteGeheel getalVerplicht

Schrijfverzoeken per minuut; deze waarde verleent geen schrijfrechten.

minimum: 0maximum: 1000000

Voorbeeld: 15

Aanvullende velden: Nee

ttl_secondsGeheel getalOptioneel

Optioneel geheel getal ttl_seconds: 300–3600 seconden (5–60 minuten). Zonder dit veld geldt standaard 900 seconden (15 minuten).

Standaard: 900Voorbeeld: 1800

Aanvullende velden: Nee

access_tokenTekenreeksVerplicht

Stuur POST /api/v1/auth/revoke met de uitgevende sleutel in Authorization: ApiKey en het token in het JSON-veld access_token. Na succes geeft volgend gebruik 401. Herhaalde, onbekende of vreemde tokens krijgen hetzelfde revoked: true; tokens van andere sleutels worden nooit verwijderd.

minLength: 1maxLength: 256

Voorbeeld: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Aanvullende velden: Nee

revokedBooleaanse waardeOptioneel

Stuur POST /api/v1/auth/revoke met de uitgevende sleutel in Authorization: ApiKey en het token in het JSON-veld access_token. Na succes geeft volgend gebruik 401. Herhaalde, onbekende of vreemde tokens krijgen hetzelfde revoked: true; tokens van andere sleutels worden nooit verwijderd.

const: true

Standaard: trueVoorbeeld: true

Aanvullende velden: Nee