Chaves API

As chaves API permitem que uma aplicação externa aprovada troque informações com o seu espaço de trabalho Versafy — por exemplo, um portal de suporte interno ou um fluxo de trabalho de relatórios — sem utilizar o início de sessão de um colega de equipa. Como uma chave concede acesso contínuo, crie uma apenas para uma aplicação e proprietário conhecidos.

Navegação: Abrir Diversos → Chaves API.

A página aparece apenas para utilizadores com permissão para gerir chaves API.

Crie uma chave API

Crie uma chave separada para cada aplicação e ambiente para poder identificar o seu propósito e revogá-la sem interromper o trabalho não relacionado.

Selecione Nova chave API.
Introduza um nome claro que identifique a aplicação e o ambiente.
Crie a chave.
Copie-o imediatamente.
Armazene-o num gestor de palavras-passe aprovado ou num armazenamento secreto de implantação.

O segredo completo é mostrado apenas uma vez. Versafy não pode voltar a exibi-lo mais tarde.

Nomeie as chaves claramente

Utilize nomes como Portal de suporte — produção ou Exportação de relatórios — teste. Evite nomes que contenham palavras-passe, dados de clientes ou o próprio segredo.

Crie chaves separadas para aplicações e ambientes separados. Isto permite revogar uma integração sem interromper outras.

Utilize as chaves com segurança

Nunca coloque uma chave nas instruções do agente, na Base de Conhecimentos, nas capturas de ecrã, nas mensagens de chat ou no código-fonte confirmado num repositório.
Nunca utilize um local do browser ou de um site público onde os visitantes o possam inspecionar.
Partilhe-o apenas através de um processo aprovado de gestão de segredos.
Trate os registos copiados e os relatórios de erros como potencialmente confidenciais.

Consulte a referência da API Versafy da sua organização para obter exemplos de pedidos e operações disponíveis.

Revogar uma chave API

Selecione Revogar para a chave exata e confirme. A revogação entra em vigor imediatamente para as aplicações que a utilizam.

Se uma chave tiver sido exposta, revogue-a primeiro, crie uma substituição, atualize a aplicação externa e reveja a atividade relevante.

Solucionar problemas de acesso à API

A chave não foi copiada

Revogue a chave inutilizável e crie uma nova. O segredo original não pode ser revelado novamente.

Uma aplicação perde acesso

Confirme se a sua chave não foi revogada, se a chave correta do espaço de trabalho está configurada e se a operação de API do cliente solicitada está disponível para esta integração.