API
API JamCloud позволяет скрипту, таблице или другому приложению читать и менять ваши пространства: получать список треков, импортировать файлы, загружать разделы и аккордовые схемы. Он видит ровно то же, что и вы, в каждом пространстве, где вы состоите.
Ваши API-ключи
Заголовок раздела «Ваши API-ключи»Личный ключ (начинается с jc_) представляет вас в API. Ключи есть не в каждом аккаунте; администратор может предоставить вам доступ. Без него в Настройки › API-ключи будет сказано, что ваш аккаунт не включает доступ к API.
В Настройки › API-ключи задайте ключу название и выберите:
- Только чтение: ключ читает и ничего не меняет.
- Чтение и запись: ключ также может импортировать, редактировать и удалять — в пределах вашей роли в каждом пространстве.
- Срок действия: бессрочно или 30, 90 либо 365 дней.
Ключ показывается один раз, сразу после Создать ключ: скопируйте его и храните в надёжном месте, как пароль. Дальше в списке видно только его начало, последнее использование и срок действия. Отозвать сразу останавливает ключ. Можно иметь 10 активных ключей.
Первый запрос
Заголовок раздела «Первый запрос»Передайте ключ в заголовке Authorization:
curl -H "Authorization: Bearer jc_…" https://api-jamcloud.australfactory.cl/api/v1/groupsЭтот запрос возвращает список ваших пространств. Большинство других маршрутов находятся внутри пространства (/api/v1/groups/<id>/…).
Чего ключ не может
Заголовок раздела «Чего ключ не может»Ключ никогда не получает доступ к аккаунту: вход, профиль, безопасность, уведомления, другие API-ключи и администрирование (/auth, /me, /admin, /realtime, /api-keys) отвечают 403 с кодом api_key_forbidden. Управляйте этим в приложении. Ключ Только чтение, который пытается что-то изменить, получает 403 api_key_read_only.
Когда API временно отключён, каждый запрос с ключом получает 503 circuit_open: подождите столько секунд, сколько указано в заголовке Retry-After, и повторите запрос. Само приложение продолжает работать.
Справочник API
Заголовок раздела «Справочник API»В справочнике API (версия 1) перечислены все маршруты, доступные по ключу, с параметрами, полями и готовым к запуску примером.