Skip to main content
La API de Square Cloud es una API REST sobre HTTPS. Cubre lo que haces en el panel: hacer deploy y controlar aplicaciones, leer sus logs y métricas, y gestionar archivos, variables de entorno, snapshots, bases de datos y workspaces. Envía y recibe JSON, con dos excepciones: upload y commit reciben un zip como multipart/form-data, y realtime transmite Server-Sent Events.

URL base

Todos los endpoints de esta referencia son relativos a:
Blob Storage es una API aparte con su propia URL base, 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 encabezado Authorization de cada solicitud. El prefijo Bearer es opcional.
La clave se muestra una sola vez, al crearla. Guárdala en tu servidor, en una variable de entorno, y nunca en código del lado del cliente ni en un repositorio. Cada clave tiene scopes que limitan lo que puede hacer: consulta Autenticación para ver el scope de cada endpoint.

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 scope account:read.
Si recibes 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 responde 2xx con "status": "success" y, cuando hay algo que devolver, los datos en response:
Las acciones como iniciar o detener responden solo { "status": "success" }. Una llamada fallida responde 4xx o 5xx con "status": "error" y un code con el que decidir qué hacer:
Los nombres de los campos en las respuestas usan 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 el 429.

Especificación OpenAPI

Toda la API está descrita en un documento OpenAPI en https://api.squarecloud.app/v2/openapi.json. Impórtalo en Postman o Insomnia, o genera un cliente a partir de él.
¿Prefieres un cliente tipado? Los SDKs de Square Cloud para JavaScript, Python y Go cubren todos los endpoints de esta referencia, y la CLI cubre las mismas tareas desde una terminal.

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.