Schémas de données: Authentification

Schémas de données: Authentification. Champs, types et contraintes des données acceptées ou renvoyées par l’API.

Schémas de données

Obtenir · Jeton — Authentification — Réponse

ApiResponse_TokenData_ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

dataTokenData Obligatoire: Exemple de réponse · TokenData.

Exemple: {"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 Obligatoire: Métadonnées de la réponse.

Exemple: {"request_id":"example"}

Champs supplémentaires: Non

Obtenir · Jeton — Authentification — Réponse

TokenData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

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:00:00Z"
expires_inEntierFacultatif: 900 secondes, soit 15 minutes après son émission. Les requêtes ne prolongent pas sa validité.

Valeur par défaut: 900Exemple: 900
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":10,"read_per_minute":60,"write_per_minute":10}
token_typeChaîneFacultatif: Bearer. Schéma d'authentification du jeton renvoyé.

const: "Bearer"

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

Champs supplémentaires: Non

Limites de requêtes

TokenRateLimitsData · 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. Zéro signifie indisponible, et non illimité.

auth_per_minuteEntierObligatoire: Demandes de jeton par minute, y compris les tentatives d’authentification échouées.

minimum: 0maximum: 1000000

Exemple: 10
read_per_minuteEntierObligatoire: Requêtes de lecture par minute.

minimum: 0maximum: 1000000

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

minimum: 0maximum: 1000000

Exemple: 10

Champs supplémentaires: Non

Obtenir · Jeton — Authentification — Corps de la requête

TokenRequest · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

ObjetChamps supplémentaires: Non

Champs supplémentaires: Non