Skip to main content
Blob Storage acepta dos tipos de credenciales en la cabecera Authorization:
  • API key: se crea en la configuración de tu cuenta. Funciona en todas las rutas, limitada por los scopes que le asignes.
  • Token de subida (squp_...): un token de corta duración que tu servidor emite con Upload Tokens. Solo sirve para subir, así que es seguro entregarlo a un navegador.
El uso de la API está sujeto a los Términos de Servicio y a la Política de Uso Aceptable.
El SDK de Blob (@squarecloud/blob) envía la credencial por ti y cubre todas las rutas de esta referencia.

​
Scopes

Una API key lleva scopes. Blob Storage lee dos de ellos: Una key sin el scope que necesita una ruta recibe 403 MISSING_SCOPE. Una key restringida a aplicaciones específicas no tiene acceso a Blob Storage y recibe 403 RESOURCE_NOT_ALLOWED.
Da a cada integración su propia key con solo el scope que necesita. Un backend que solo sirve archivos necesita blob:read; un job que solo sube necesita blob:write.

​
Tokens de subida

Un token de subida solo se acepta en Object Post y en las rutas de subida por partes. Cualquier otra ruta responde 403 UPLOAD_TOKEN_NOT_ALLOWED. El token fija el nombre, el prefijo, la visibilidad, el tamaño y los tipos de archivo elegidos al emitirlo, y deja de funcionar cuando expira, cuando se agotan sus usos o cuando se revoca la API key que lo emitió.

​
Gateway S3

Las herramientas S3 no envían la API key en sí. Firman las solicitudes (SigV4) con un par de claves de acceso derivado de ella: obtenlo en S3 Credentials y lee Compatibilidad con S3.

​
Errores

Las respuestas de error siguen la forma { "status": "error", "code": "SOME_CODE" }, a veces con un message que explica el caso. Toma decisiones según code, nunca según message. La lista completa está en Errores.

​
Errores globales

Cualquier ruta de Blob también puede devolver estos:

Límites y restricciones

Conoce los límites y restricciones de la API de Square Cloud.