Salta ai contenuti

API

L’API di JamCloud permette a uno script, a un foglio di calcolo o a un’altra app di leggere e modificare i tuoi spazi: elencare le tracce, importare file, recuperare sezioni e griglie di accordi. Vede esattamente ciò che vedi tu, in ogni spazio di cui sei membro.

Una chiave personale (inizia con jc_) ti rappresenta presso l’API. Non tutti gli account includono le chiavi; un amministratore può concederti l’accesso. Senza, Impostazioni › Chiavi API indica che il tuo account non include l’accesso all’API.

In Impostazioni › Chiavi API, dai un nome alla chiave, poi scegli:

  • Sola lettura: la chiave legge, senza mai modificare nulla.
  • Lettura e scrittura: la chiave può anche importare, modificare ed eliminare, nei limiti del tuo ruolo in ogni spazio.
  • La scadenza: mai, oppure tra 30, 90 o 365 giorni.

La chiave viene mostrata una sola volta, subito dopo Crea chiave: copiala e conservala al sicuro, come una password. In seguito l’elenco ne mostra solo l’inizio, l’ultimo uso e la scadenza. Revoca ferma subito una chiave. Puoi avere 10 chiavi attive.

Invia la chiave nell’intestazione Authorization:

curl -H "Authorization: Bearer jc_…" https://api-jamcloud.australfactory.cl/api/v1/groups

Questa chiamata elenca i tuoi spazi. La maggior parte delle altre rotte si trova sotto uno spazio (/api/v1/groups/<id>/…).

Una chiave non raggiunge mai il tuo account: accesso, profilo, sicurezza, notifiche, altre chiavi API e amministrazione (/auth, /me, /admin, /realtime, /api-keys) rispondono 403 con il codice api_key_forbidden. Gestiscili nell’app. Una chiave in Sola lettura che prova a modificare qualcosa riceve 403 api_key_read_only.

Quando l’API è temporaneamente disattivata, ogni chiamata con una chiave riceve 503 circuit_open: attendi i secondi indicati nell’intestazione Retry-After, poi riprova. L’app continua a funzionare.

Il riferimento dell’API (versione 1) elenca ogni rotta che una chiave può chiamare, con parametri, campi e un esempio pronto da eseguire.