Skip to main content
Blob Storage accepte deux types d’identifiants dans l’en-tête Authorization :
  • Clé API : créée dans les paramètres de votre compte. Elle fonctionne sur toutes les routes, dans la limite des scopes que vous lui attribuez.
  • Jeton d’envoi (squp_...) : un jeton de courte durée que votre serveur génère avec Jetons d’envoi. Il sert uniquement à envoyer des fichiers, il peut donc être confié sans risque à un navigateur.
L’utilisation de l’API est soumise aux Conditions d’utilisation et à la Politique d’utilisation acceptable.
Le SDK Blob (@squarecloud/blob) envoie les identifiants pour vous et couvre chaque route de cette référence.

​
Scopes

Une clé API porte des scopes. Blob Storage en lit deux : Une clé sans le scope requis par une route reçoit 403 MISSING_SCOPE. Une clé restreinte à des applications spécifiques n’a pas accès à Blob Storage et reçoit 403 RESOURCE_NOT_ALLOWED.
Attribuez à chaque intégration sa propre clé avec uniquement le scope dont elle a besoin. Un backend qui ne fait que servir des fichiers a besoin de blob:read ; une tâche qui ne fait qu’envoyer des fichiers a besoin de blob:write.

​
Jetons d’envoi

Un jeton d’envoi n’est accepté que sur Object Post et les routes d’envoi chunked. Toute autre route répond 403 UPLOAD_TOKEN_NOT_ALLOWED. Le jeton fige le nom, le préfixe, la visibilité, la taille et les types de fichiers choisis lors de sa création, et cesse de fonctionner lorsqu’il expire, lorsque ses utilisations sont épuisées ou lorsque la clé API qui l’a généré est révoquée.

​
Passerelle S3

Les outils S3 n’envoient pas la clé API elle-même. Ils signent les requêtes (SigV4) avec une paire de clés d’accès dérivée de celle-ci : obtenez-la via Identifiants S3 et lisez Compatibilité S3.

​
Erreurs

Les réponses d’erreur suivent la forme { "status": "error", "code": "SOME_CODE" }, parfois avec un message qui explique le cas. Basez votre logique sur code, jamais sur message. La liste complète se trouve dans Erreurs.

​
Erreurs globales

Toute route Blob peut également renvoyer celles-ci :

Limites et restrictions

Découvrez les limites et restrictions de l’API Square Cloud.