Documentation APIAuthentification et idempotence
Clés API, portées, identifiants de requête et reprises sûres
Authentification par jeton bearer
Créez et révoquez les clés dans Paramètres → Clés API. Le secret n'est affiché qu'une seule fois. Envoyez-le dans l'en-tête standard :
Authorization: Bearer sd_YOUR_KEYSeul l'en-tête Authorization est accepté. Les identifiants passés en
query-string et X-API-Key ne sont pas pris en charge. Une clé manquante,
invalide, expirée ou révoquée renvoie 401 UNAUTHORIZED. Une clé valide sans la
portée du point de terminaison renvoie 403 FORBIDDEN.
Portées
| Portée | Autorise |
|---|---|
images:generate | créer des jobs de génération |
images:edit | créer des jobs de modification |
images:convert | créer des jobs de conversion |
jobs:read | lire les jobs du même compte |
credits:read | lire le solde courant |
Utilisez des clés restreintes distinctes par application et par environnement. Révoquer une clé n'affecte pas les jobs déjà créés pour le compte.
Idempotence
Les trois points de terminaison POST exigent un Idempotency-Key de 8 à 255
caractères. Rappeler le même point de terminaison avec la même clé et la même
requête canonique renvoie le job d'origine, sans nouvelle réservation de
crédits. Réutiliser la clé avec un contenu différent renvoie
409 IDEMPOTENCY_CONFLICT.
Pour les requêtes multipart, les octets de l'image source font partie de l'identité. Changer l'image envoyée en gardant la clé constitue donc un conflit.
Identifiants de requête
Chaque réponse comporte X-Request-Id. Les corps d'erreur le répètent dans
error.request_id. Ces identifiants peuvent être stockés sans risque dans les
journaux applicatifs.