Chaves de API

Uma chave de API permite que outro programa utilize a API do AurionAI para a sua organização. Cada chave tem uma lista de permissões, denominadas âmbitos. Uma chave só pode fazer o que os seus âmbitos permitem.

Disponibilidade: todos os perfis. Apenas administradores.

Pré-requisitos

• Tem a função Proprietário ou Administrador. Os outros utilizadores veem Acesso Negado.
• Sabe o que o programa precisa de fazer, para que lhe atribua apenas os âmbitos necessários.

Abrir as chaves de API

1. Na barra lateral, selecione Configuração.
2. Abra a categoria Sistema.
3. Selecione Chaves API.

A tabela Chaves ativas mostra o nome, o início da chave, os âmbitos, o estado, a data de criação, a última utilização e a data de expiração de cada chave. As chaves revogadas são listadas em Chaves revogadas.

Criar uma chave

1. Selecione Criar chave.
2. Em Nome, escreva um nome que indique qual o programa que utiliza a chave.
3. Opcional: em Descrição (opcional), descreva para que serve a chave.
4. Em Expiração, escolha quando a chave expira. O valor predefinido é 90 dias. Também pode escolher Sem expiração.
5. Em Permissões, selecione os âmbitos. Uma caixa de verificação de grupo seleciona todos os âmbitos do grupo.
6. Selecione Criar chave.
7. Copie a chave com Copiar chave API. O AurionAI mostra a chave completa apenas esta vez.
8. Selecione Copiei — dispensar.

O programa envia a chave no cabeçalho X-API-Key de cada pedido. Uma chave começa com itsm_sk_live_, ou com itsm_sk_test_ para uma organização de sandbox.

Âmbitos

Notas sobre os âmbitos:

• Para publicar artigos da base de conhecimento com imagens, uma chave precisa de kb:read, kb:write e kb:media. Apenas com kb:read e kb:write, não é possível carregar imagens. Não existe nenhum âmbito para eliminar artigos.
• Para exportar a transcrição de uma chamada, uma chave precisa de conversations:read, conversations:write e conversations:export; as chaves criadas antes de conversations:export existir não podem exportar até criar uma chave de substituição que o inclua.
• Não existe nenhum âmbito de "todas as permissões". Selecione cada âmbito de que o programa necessita.

Rodar uma chave

Rode uma chave quando suspeitar que outra pessoa a conhece.

1. Na coluna Ações da chave, selecione Girar chave.
2. Na caixa de diálogo Girar chave API, selecione Girar chave.
3. Copie a nova chave. A chave antiga deixa de funcionar. Atualize o programa com a nova chave.

A nova chave mantém o nome, os âmbitos e a data de expiração da chave antiga.

Revogar uma chave

1. Na coluna Ações da chave, selecione Revogar chave.
2. Na caixa de diálogo Revogar chave API, selecione Revogar chave.

A mensagem Chave API revogada é apresentada. Os programas que utilizam a chave perdem o acesso imediatamente. Esta ação não pode ser anulada.

Resultado

Uma nova chave funciona imediatamente, apenas com os seus âmbitos. A coluna Estado mostra Ativa, Expira em breve nos últimos sete dias antes da expiração, Expirada ou Revogada.

Se algo correr mal

• Selecione pelo menos uma permissão Selecione pelo menos um âmbito.
• Falha ao criar chave API Tente novamente. Se voltar a falhar, contacte o suporte do AurionAI. Leia Obter ajuda.
• Segredo indisponível O AurionAI não mostrou a chave. Não utilize esta chave. Revogue-a e crie uma nova.
• Perdeu a chave. O AurionAI não a pode mostrar novamente. Rode a chave ou crie uma nova.
• Um pedido com a chave é recusado. A chave não tem o âmbito para este pedido, ou está expirada ou revogada. Verifique as colunas Âmbitos e Estado.
• Um programa não consegue carregar imagens para a base de conhecimento. Adicione kb:media: crie uma nova chave com kb:read, kb:write e kb:media.

Artigos relacionados

• API para programadores: utilização e webhooks
• Ligar as suas ferramentas de ITSM e CS
• Obter ajuda