Chaves de API
Uma chave de API deixa outro sistema chamar a API do Noxus Core em nome da sua organização.
Acesse Integrações → API → API Keys.
Criar
- Clique em Nova chave
- Dê um nome que diga quem vai usar (
Zabbix da matriz,Script de importação) — daqui a um ano você não vai lembrar o que é "chave 3" - Marque os escopos
- Salve
Copie e guarde num cofre de senhas no momento da criação. Ela não pode ser consultada depois — perdeu, cria outra e revoga a antiga.
Escopos
Escopo é o que a chave pode fazer. Existem os amplos (cobrem um recurso inteiro) e os específicos (um endpoint só).
Geral
| Escopo | Alcance |
|---|---|
read | Leitura de todos os recursos |
write | Escrita em todos os recursos |
* | Acesso total. Equivale a todos os escopos juntos |
Chamados
| Escopo | Endpoint |
|---|---|
tickets:list | GET /tickets |
tickets:get | GET /tickets/{id} |
tickets:create | POST /tickets |
tickets:update | PATCH /tickets/{id} |
tickets:delete | DELETE /tickets/{id} |
tickets:messages:read | GET /tickets/{id}/messages |
tickets:messages:write | POST /tickets/{id}/messages |
tickets:read / tickets:write | Amplos: todas as leituras / todas as escritas |
CRM
crm:list, crm:get, crm:create, crm:update, crm:delete, e os amplos
crm:read e crm:write. Cobrem clientes, contatos e oportunidades.
Apontamentos e faturamento
time:list, time:create, time:read, time:write, billing:list,
billing:read.
Metadados
meta:list e meta:read — filas, categorias, campos e usuários. É o que um
integrador precisa para montar as opções antes de criar um chamado.
Uma chave que só cria chamado precisa de tickets:create, não de *. Quando a
chave vazar — e alguma vai vazar — a diferença entre os dois é o tamanho do
estrago.
Revogar
Revogue na lista de chaves. O efeito é imediato: a próxima chamada com aquela chave é recusada.
Revogue sempre que: alguém que tinha acesso à chave saiu da equipe, a chave apareceu em um repositório ou em log, ou o sistema que a usava foi desligado.
Uso
A aba Uso mostra o volume de chamadas por chave. Serve para duas coisas: descobrir qual integração está gastando mais, e perceber uma chave que devia estar parada e não está.
Referência da API
A referência completa dos endpoints, com os parâmetros de cada um, está em /api-docs na própria plataforma. A aba Testador dispara chamadas de exemplo, com trechos prontos em Node.js, Python e PHP.