multipart/form-data, y realtime transmite Server-Sent Events.
URL base
Todos los endpoints de esta referencia son relativos a:https://blob.squarecloud.app/v1, y acepta la misma clave de API.
Autenticación
Crea una clave de API en la configuración de seguridad de tu cuenta y envíala en el encabezadoAuthorization de cada solicitud. El prefijo Bearer es opcional.
Tu primera solicitud
Información de la cuenta devuelve tu perfil, tu plan y todas las aplicaciones y bases de datos que te pertenecen. Necesita una clave con el scopeaccount:read.
401 ACCESS_DENIED, la clave falta o no se reconoce. Si recibes 403 MISSING_SCOPE, la clave funciona pero no tiene account:read.
Formato de respuesta
Una llamada correcta responde2xx con "status": "success" y, cuando hay algo que devolver, los datos en response:
{ "status": "success" }. Una llamada fallida responde 4xx o 5xx con "status": "error" y un code con el que decidir qué hacer:
snake_case. Todos los códigos, con lo que debes hacer en cada caso, están en Errores.
IDs
- Las aplicaciones y bases de datos tienen un id hexadecimal de 32 caracteres, como
a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d. Obtenlos en Información de la cuenta o en la dirección del recurso en el panel. - Una aplicación compartida contigo a través de un workspace se indica como
<appId>-<workspaceId>en la ruta, por ejemplo/v2/apps/<appId>-<workspaceId>/status. - Los workspaces tienen un id hexadecimal de 32 caracteres. Los workspaces más antiguos conservan uno de 40 caracteres.
Límites
Cada cuenta tiene un presupuesto de solicitudes por cada 60 segundos, definido por su plan, y algunos endpoints tienen su propio límite, indicado en su página. Consulta Límites y restricciones para ver los valores y Errores para saber cómo funciona el429.
Especificación OpenAPI
Toda la API está descrita en un documento OpenAPI enhttps://api.squarecloud.app/v2/openapi.json. Impórtalo en Postman o Insomnia, o genera un cliente a partir de él.
Próximos pasos
Autenticación y scopes
Elige los scopes que necesita cada integración.
Códigos de error
Todos los códigos que devuelve la API y cómo gestionarlos.
Subir una aplicación
Haz deploy de un zip con una sola solicitud.
Límites de tasa
Presupuestos de solicitudes por plan.

