Pular para o conteúdo

API

A API do JamCloud permite que um script, uma planilha ou outro app leia e altere seus espaços: listar faixas, importar arquivos, buscar seções e cifras. Ela vê exatamente o que você vê, em cada espaço do qual você é membro.

Uma chave pessoal (ela começa com jc_) representa você na API. Nem todas as contas incluem chaves; um administrador pode conceder o acesso. Sem ele, Configurações › Chaves de API informa que sua conta não inclui acesso à API.

Em Configurações › Chaves de API, dê um nome à chave e escolha:

  • Somente leitura: a chave lê e nunca altera nada.
  • Leitura e escrita: a chave também pode importar, editar e excluir, dentro do seu papel em cada espaço.
  • A validade: nunca, ou em 30, 90 ou 365 dias.

A chave aparece uma única vez, logo após Criar chave: copie-a e guarde-a em local seguro, como uma senha. Depois a lista mostra só o início dela, o último uso e a validade. Revogar interrompe uma chave na hora. Você pode ter 10 chaves ativas.

Envie a chave no cabeçalho Authorization:

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

Isso lista seus espaços. A maioria das outras rotas fica sob um espaço (/api/v1/groups/<id>/…).

Uma chave nunca chega à sua conta: login, perfil, segurança, notificações, outras chaves de API e administração (/auth, /me, /admin, /realtime, /api-keys) respondem 403 com o código api_key_forbidden. Gerencie isso no app. Uma chave Somente leitura que tenta alterar algo recebe 403 api_key_read_only.

Quando a API está temporariamente desligada, toda chamada com uma chave recebe 503 circuit_open: espere os segundos indicados no cabeçalho Retry-After e tente de novo. O app continua funcionando.

A referência da API (versão 1) lista cada rota que uma chave pode chamar, com parâmetros, campos e um exemplo pronto para executar.