Como posso criar e gerir chaves API para ligar outro software ao Corfix?

Se a sua empresa pretender ligar o Corfix a outro sistema de software, como uma plataforma de processamento salarial, de contabilidade ou de ERP, necessitará de uma chave API. Este artigo orienta-o na criação, edição e eliminação de chaves API e explica quem, na sua equipa, pode geri-las.

• Necessita de autorização para gerir chaves API. A sua função deve ter as autorizações de chaves API ativadas (consulte «Quem pode gerir chaves API?» abaixo). Caso não veja o botão «Gerir chaves API», contacte o administrador da sua empresa.
• Contacte o seu Gestor de Sucesso do Cliente ou consulte a Documentação da API.
• O segredo da chave é apresentado apenas uma vez. Quando cria uma chave, o Corfix apresenta o segredo uma única vez. Se o perder, não poderá recuperá-lo — terá de eliminar a chave e criar uma nova.
• A eliminação de uma chave é definitiva. Qualquer ligação que utilize essa chave deixará imediatamente de funcionar.

Uma chave API funciona como uma palavra-passe especial para software, em vez de para pessoas. Permite que outro sistema, como a sua plataforma de processamento salarial ou de contabilidade, comunique de forma segura com o Corfix em nome da sua empresa, sem que seja necessário que alguém inicie sessão manualmente.

Cada chave é composta por duas partes:

• Um Nome e uma Descrição, para que se possa lembrar para que serve a chave (por exemplo, «Acumatica»).
• Um «Segredo», que é a palavra-passe propriamente dita utilizada pelo outro software. Trate-o como qualquer outra palavra-passe: mantenha-o confidencial e guarde-o num local seguro.

A cada chave é também atribuída uma Função, que controla o que o software ligado está autorizado a ver e a fazer no Corfix. Por exemplo, uma chave à qual foi atribuída a função de Administrador pode aceder às mesmas informações que um utilizador com funções de administrador.

Criar uma chave API

1. Aceda a «Detalhes da minha conta» no menu à esquerda.
2. Em «Detalhes da empresa», clique em «Gerir chaves API».
3. Na página «Chaves API», clique no botão azul «Adicionar», no canto superior direito.
4. Na janela «Adicionar chave API»:
   • Introduza um Nome para a chave (obrigatório, com pelo menos 3 caracteres). Utilize um nome que descreva a que se refere, como «Acumatica».
   • Opcionalmente, adicione uma «Descrição» com mais pormenores.
   • Selecione uma Função. Isto determina o que o software ligado pode aceder. Escolha a função mais restrita que ainda permita que a ligação funcione.
5. Clique em «Guardar».
6. Aparece uma janela de confirmação com o «Segredo» da sua chave. Clique em «Copiar» e guarde o segredo num local seguro imediatamente — esta é a única vez que ele será apresentado.
7. Clique em «OK» para concluir. A sua nova chave aparece agora na lista de Chaves API.

Editar ou eliminar uma chave API

1. Na página «Chaves API», localize a chave na lista.
2. Clique em «Escolher ação» na coluna «Ações»
3. Selecione «Editar» para atualizar o nome, a descrição ou a função da chave, ou selecione «Eliminar» para a remover.

Aviso: A eliminação de uma chave desliga imediatamente qualquer software que a esteja a utilizar. Só deve eliminar uma chave se tiver a certeza de que já não é necessária ou se acreditar que o segredo foi exposto.

Quem pode gerir as chaves API?

Os administradores podem controlar quais as funções autorizadas a trabalhar com chaves API. Nas definições da sua função, a secção «Permissões de chaves API» contém quatro botões de alternância:

1. Ver chaves API — consulte a lista de chaves.
2. Adicionar chave API — crie novas chaves.
3. Editar chave de API — altere o nome, a descrição ou a função de uma chave.
4. Eliminar chave API — remova chaves.

Ative apenas as permissões de que cada função necessita e, em seguida, clique em «Guardar».

• Ligue o seu software de processamento salarial: envie automaticamente dados de horas e salários entre o Corfix e a sua plataforma de processamento salarial, eliminando as exportações manuais.
• Sincronize com o seu sistema de contabilidade ou ERP: mantenha os projetos e registos alinhados entre sistemas, como o Acumatica ou o Sage.
• Controle exatamente o que o software ligado pode aceder: Atribuir uma função a cada chave significa que uma ligação só vê o que precisa, nada mais.
• Revogue o acesso instantaneamente: se uma ligação já não for necessária ou se uma chave secreta for exposta, a eliminação da chave interrompe o acesso imediatamente.
• Acompanhe as suas ligações: a lista de chaves API apresenta o nome, a descrição, a data de criação e a função de cada chave, para que saiba sempre o que está ligado e porquê.