Schemi dei dati: Autenticazione

dataTokenData Obbligatorio

Esempio di risposta · TokenData.

Esempio: {"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 Obbligatorio

Metadati della risposta.

Esempio: {"request_id":"example"}

Campi aggiuntivi: No

dataTokenRevokedData Obbligatorio

Esempio di risposta · TokenRevokedData.

Esempio: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obbligatorio

Metadati della risposta.

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

Campi aggiuntivi: No

access_tokenStringaObbligatorio

Token per l’header Authorization: Bearer. Imposta SHOPENTLY_ACCESS_TOKEN prima di eseguire l’esempio separato.

Esempio: "EXAMPLE_ACCESS_TOKEN"

expires_atStringaObbligatorio

Data e ora di scadenza in UTC. Le restrizioni di accesso attuali possono bloccare il token prima.

format: "date-time"

Esempio: "2026-01-01T12:15:00Z"

expires_inInteroObbligatorio

Durata effettiva in secondi; questo esempio richiede 1800. Le richieste non la prolungano. expires_at indica la scadenza in UTC.

minimum: 300maximum: 3600

Esempio: 1800

permissionsArray <Stringa> Obbligatorio

permissions elenca i permessi effettivi correnti: l’intersezione dei permessi della chiave, del suo autore e del piano del negozio, inclusi quelli degli addon attivi. L’accesso viene verificato a ogni richiesta.

Esempio: ["orders.order:read"]

rate_limitsTokenRateLimitsData Obbligatorio

Engine ≥ 4.143.0. Ogni risposta del token include data.rate_limits dalla politica del negozio al momento dell’emissione. Tutte le chiavi condividono questi limiti; un nuovo token non li azzera. Un cambio di piano può applicarsi prima della scadenza del token.

Esempio: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_typeStringaFacoltativo

Bearer. Schema di autenticazione del token restituito.

const: "Bearer"

Valore predefinito: "Bearer"Esempio: "Bearer"

warningsArray <TokenLifetimeWarning > Obbligatorio

Un intero fuori intervallo applica 900 secondi e restituisce warnings con token.ttl_out_of_range e documentation_url su learn.shopently.com. L’omissione non genera avvisi; i tipi non validi restituiscono 422.

Esempio: []

Campi aggiuntivi: No

applied_secondsInteroFacoltativo

900 s (15 min)

Valore predefinito: 900

codeStringaFacoltativo

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Valore predefinito: "token.ttl_out_of_range"

documentation_urlStringaFacoltativo

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

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

fieldStringaFacoltativo

ttl_seconds

const: "ttl_seconds"

Valore predefinito: "ttl_seconds"

max_secondsInteroFacoltativo

3600 s (60 min)

Valore predefinito: 3600

messageStringaFacoltativo

Un intero fuori intervallo applica 900 secondi e restituisce warnings con token.ttl_out_of_range e documentation_url su learn.shopently.com. L’omissione non genera avvisi; i tipi non validi restituiscono 422.

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

min_secondsInteroFacoltativo

300 s (5 min)

Valore predefinito: 300

Campi aggiuntivi: No

auth_per_minuteInteroObbligatorio

Richieste di emissione e revoca del token al minuto, inclusi i tentativi di autenticazione falliti. Entrambe condividono il limite auth.

minimum: 0maximum: 1000000

Esempio: 1

read_per_minuteInteroObbligatorio

Richieste di lettura al minuto.

minimum: 0maximum: 1000000

Esempio: 2

write_per_minuteInteroObbligatorio

Richieste di scrittura al minuto; questo valore non concede permessi di scrittura.

minimum: 0maximum: 1000000

Esempio: 15

Campi aggiuntivi: No

ttl_secondsInteroFacoltativo

Intero facoltativo ttl_seconds: 300–3600 secondi (5–60 minuti). Se omesso, il valore predefinito è 900 secondi (15 minuti).

Valore predefinito: 900Esempio: 1800

Campi aggiuntivi: No

access_tokenStringaObbligatorio

Invia POST /api/v1/auth/revoke con la chiave emittente in Authorization: ApiKey e il token nel campo JSON access_token. Dopo il successo, l’uso successivo restituisce 401. Token ripetuti, sconosciuti o altrui ricevono lo stesso revoked: true; i token di altre chiavi non vengono eliminati.

minLength: 1maxLength: 256

Esempio: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Campi aggiuntivi: No

revokedBooleanoFacoltativo

Invia POST /api/v1/auth/revoke con la chiave emittente in Authorization: ApiKey e il token nel campo JSON access_token. Dopo il successo, l’uso successivo restituisce 401. Token ripetuti, sconosciuti o altrui ricevono lo stesso revoked: true; i token di altre chiavi non vengono eliminati.

const: true

Valore predefinito: trueEsempio: true

Campi aggiuntivi: No