Criar uma chave
- Abra Configurações, depois Chaves de API, e escolha Criar chave.
- Dê a ela o nome do sistema que vai usá-la. Escolha um escopo e uma validade opcional.
- Copie a chave agora e guarde-a no cofre de segredos do seu sistema.
Important: A chave completa é mostrada uma única vez. Se você a perder, revogue-a e crie outra.
| Escopo | Atua como |
|---|---|
| Somente leitura | Um visualizador. Pode ler o que um visualizador pode ler. |
| Leitura e gravação | No máximo um gestor. Pode criar e alterar o que um gestor pode. |
Como usar
Envie a chave no cabeçalho Authorization de cada requisição à API do aplicativo:
Authorization: Bearer ehk_...
- Uma chave funciona apenas para a sua própria organização e apenas com o seu escopo.
- Nenhum cabeçalho CSRF é necessário ao usar uma chave.
- Uma chave não pode criar nem gerenciar outras chaves.
- As requisições feitas com uma chave são registradas no registro de auditoria como a chave de API.
Revogar
Escolha Revogar em uma chave e ela deixa de funcionar imediatamente, de modo que os sistemas que a usam recebem erros 401. Uma chave também deixa de funcionar quando o membro que a criou sai da organização. A lista mostra quando cada chave foi usada pela última vez.
Tip: Sempre que possível, dê a cada integração a sua própria chave somente leitura. Se uma vazar, você revoga apenas essa.
Para obter a descrição da API para seus desenvolvedores, faça o pedido pelo formulário de contato.