Schémas de données: Authentification

dataTokenData Obligatoire

Exemple de réponse · TokenData.

Exemple: {"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 Obligatoire

Métadonnées de la réponse.

Exemple: {"request_id":"example"}

Champs supplémentaires: Non

dataTokenRevokedData Obligatoire

Exemple de réponse · TokenRevokedData.

Exemple: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatoire

Métadonnées de la réponse.

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

Champs supplémentaires: Non

access_tokenChaîneObligatoire

Jeton de l’en-tête Authorization: Bearer. Définissez SHOPENTLY_ACCESS_TOKEN avant d’exécuter l’exemple séparé.

Exemple: "EXAMPLE_ACCESS_TOKEN"

expires_atChaîneObligatoire

Date et heure d’expiration en UTC. Les restrictions d’accès en vigueur peuvent bloquer le jeton plus tôt.

format: "date-time"

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

expires_inEntierObligatoire

Durée réelle en secondes ; cet exemple demande 1800. Les requêtes ne la prolongent pas. expires_at indique l’expiration en UTC.

minimum: 300maximum: 3600

Exemple: 1800

permissionsTableau <Chaîne> Obligatoire

permissions indique les droits effectifs actuels : l’intersection des droits de la clé, de son auteur et de l’offre de la boutique, y compris les droits actifs des extensions. Chaque requête vérifie à nouveau l’accès.

Exemple: ["orders.order:read"]

rate_limitsTokenRateLimitsData Obligatoire

Engine ≥ 4.143.0. Chaque réponse de jeton contient data.rate_limits issu de la politique de la boutique au moment de son émission. Toutes les clés partagent ces quotas ; un nouveau jeton ne les réinitialise pas. Un changement d’offre peut s’appliquer avant l’expiration du jeton.

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

token_typeChaîneFacultatif

Bearer. Schéma d'authentification du jeton renvoyé.

const: "Bearer"

Valeur par défaut: "Bearer"Exemple: "Bearer"

warningsTableau <TokenLifetimeWarning > Obligatoire

Un entier hors limites applique 900 secondes et renvoie warnings avec token.ttl_out_of_range et documentation_url vers learn.shopently.com. L’absence du champ ne produit aucun avertissement ; un type invalide renvoie 422.

Exemple: []

Champs supplémentaires: Non

applied_secondsEntierFacultatif

900 s (15 min)

Valeur par défaut: 900

codeChaîneFacultatif

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Valeur par défaut: "token.ttl_out_of_range"

documentation_urlChaîneFacultatif

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

Valeur par défaut: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"

fieldChaîneFacultatif

ttl_seconds

const: "ttl_seconds"

Valeur par défaut: "ttl_seconds"

max_secondsEntierFacultatif

3600 s (60 min)

Valeur par défaut: 3600

messageChaîneFacultatif

Un entier hors limites applique 900 secondes et renvoie warnings avec token.ttl_out_of_range et documentation_url vers learn.shopently.com. L’absence du champ ne produit aucun avertissement ; un type invalide renvoie 422.

Valeur par défaut: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."

min_secondsEntierFacultatif

300 s (5 min)

Valeur par défaut: 300

Champs supplémentaires: Non

auth_per_minuteEntierObligatoire

Demandes d’émission et de révocation de jetons par minute, y compris les échecs d’authentification. Les deux opérations partagent le quota auth.

minimum: 0maximum: 1000000

Exemple: 1

read_per_minuteEntierObligatoire

Requêtes de lecture par minute.

minimum: 0maximum: 1000000

Exemple: 2

write_per_minuteEntierObligatoire

Requêtes d’écriture par minute ; cette valeur n’accorde aucun droit d’écriture.

minimum: 0maximum: 1000000

Exemple: 15

Champs supplémentaires: Non

ttl_secondsEntierFacultatif

Entier facultatif ttl_seconds : 300–3600 secondes (5–60 minutes). Sans ce champ, la valeur par défaut est 900 secondes (15 minutes).

Valeur par défaut: 900Exemple: 1800

Champs supplémentaires: Non

access_tokenChaîneObligatoire

Envoyez POST /api/v1/auth/revoke avec la clé émettrice dans Authorization: ApiKey et le jeton dans le champ JSON access_token. Ensuite, toute nouvelle utilisation renvoie 401. Un jeton répété, inconnu ou étranger reçoit le même revoked: true ; les jetons des autres clés ne sont jamais supprimés.

minLength: 1maxLength: 256

Exemple: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Champs supplémentaires: Non

revokedBooléenFacultatif

Envoyez POST /api/v1/auth/revoke avec la clé émettrice dans Authorization: ApiKey et le jeton dans le champ JSON access_token. Ensuite, toute nouvelle utilisation renvoie 401. Un jeton répété, inconnu ou étranger reçoit le même revoked: true ; les jetons des autres clés ne sont jamais supprimés.

const: true

Valeur par défaut: trueExemple: true

Champs supplémentaires: Non