API
The JamCloud API lets a script, a spreadsheet or another app read and change your workspaces: list tracks, import files, fetch sections and charts. It sees exactly what you see, in every workspace you belong to.
Your API keys
Section titled “Your API keys”A personal key (it starts with jc_) stands for you in the API. Not every account includes keys; an administrator can grant you access. Without it, Settings › API keys tells you your account doesn’t include API access.
In Settings › API keys, give the key a name, then choose:
- Read only: the key can read, never change anything.
- Read and write: the key can also import, edit and delete, within your role in each workspace.
- When it expires: never, or in 30, 90 or 365 days.
The key is shown once, right after Create key: copy it and keep it somewhere safe, like a password. The list then shows only its start, when it was last used and when it expires. Revoke stops a key at once. You can have 10 active keys.
Make a call
Section titled “Make a call”Send the key in the Authorization header:
curl -H "Authorization: Bearer jc_…" https://api-jamcloud.australfactory.cl/api/v1/groupsThis lists your workspaces. Most other routes live under a workspace (/api/v1/groups/<id>/…).
What a key can’t do
Section titled “What a key can’t do”A key never reaches your account: sign-in, profile, security, notifications, other API keys and administration (/auth, /me, /admin, /realtime, /api-keys) answer 403 with the code api_key_forbidden. Manage those in the app. A Read only key that tries to change something gets 403 api_key_read_only.
When the API is temporarily off, every call with a key gets 503 circuit_open: wait the number of seconds in the Retry-After header, then try again. The app itself keeps working.
API reference
Section titled “API reference”The API reference (version 1) lists every route a key can call, with its parameters, fields and a ready-to-run example.