Skip to main content
L’API di Square Cloud è un’API REST su HTTPS. Copre ciò che fai nella dashboard: deploy e controllo delle applicazioni, lettura di log e metriche, gestione di file, variabili d’ambiente, snapshot, database e workspace. Invia e riceve JSON, con due eccezioni: upload e commit accettano uno zip come multipart/form-data, e realtime trasmette Server-Sent Events.

​
URL base

Ogni endpoint di questa reference è relativo a:
Blob Storage è un’API separata con un proprio URL base, https://blob.squarecloud.app/v1, e accetta la stessa chiave API.

​
Autenticazione

Crea una chiave API nelle impostazioni di sicurezza del tuo account e inviala nell’header Authorization di ogni richiesta. Il prefisso Bearer è facoltativo.
La chiave viene mostrata una sola volta, al momento della creazione. Conservala sul tuo server, in una variabile d’ambiente, e mai nel codice lato client o in un repository. Ogni chiave ha degli scope che limitano cosa può fare: consulta Autenticazione per lo scope di ogni endpoint.

​
La tua prima richiesta

Informazioni sull’account restituisce il tuo profilo, il tuo piano e tutte le applicazioni e i database di cui sei proprietario. Richiede una chiave con lo scope account:read.
Se ricevi 401 ACCESS_DENIED, la chiave è mancante o non viene riconosciuta. Se ricevi 403 MISSING_SCOPE, la chiave funziona ma non ha account:read.

​
Formato delle risposte

Una chiamata riuscita risponde 2xx con "status": "success" e, quando c’è qualcosa da restituire, i dati in response:
Azioni come l’avvio o l’arresto rispondono solo { "status": "success" }. Una chiamata non riuscita risponde 4xx o 5xx con "status": "error" e un code su cui basare la logica:
I nomi dei campi nelle risposte usano snake_case. Ogni codice, con cosa fare, è in Errori.

​
ID

  • Applicazioni e database hanno un id esadecimale di 32 caratteri, come a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d. Lo trovi in Informazioni sull’account o nell’indirizzo della risorsa nella dashboard.
  • Un’applicazione condivisa con te tramite un workspace si indica come <appId>-<workspaceId> nel percorso, ad esempio /v2/apps/<appId>-<workspaceId>/status.
  • I workspace hanno un id esadecimale di 32 caratteri. I workspace più vecchi mantengono un id di 40 caratteri.

​
Limiti

Ogni account ha un budget di richieste ogni 60 secondi, stabilito dal suo piano, e alcuni endpoint hanno un proprio limite, indicato nella loro pagina. Consulta Limiti e restrizioni per i valori ed Errori per capire come funziona il 429.

​
Specifica OpenAPI

L’intera API è descritta in un documento OpenAPI all’indirizzo https://api.squarecloud.app/v2/openapi.json. Importalo in Postman o Insomnia, oppure genera un client a partire da esso.
Preferisci un client tipizzato? Gli SDK di Square Cloud per JavaScript, Python e Go coprono ogni endpoint di questa reference, e la CLI svolge le stesse attività dal terminale.

​
Prossimi passi

Autenticazione e scope

Scegli gli scope di cui ha bisogno ogni integrazione.

Codici di errore

Ogni codice restituito dall’API e come gestirlo.

Carica un'applicazione

Fai il deploy di uno zip con una sola richiesta.

Rate limit

Budget di richieste per piano.