Chaves de API

A seção de Chaves de API permite criar e gerenciar tokens de acesso para integrar a plataforma com sistemas externos. Este recurso está disponível apenas para empresas com o acesso à API habilitado (planos Premium e Enterprise).

1. Acessando o gerenciamento de chaves

Você pode acessar as chaves de API de duas formas:

• Pela tela Minha Empresa → botão Chaves de API.
• Pelo menu lateral → Chaves de API (se exibido).

2. Visualizando as chaves existentes

A tela exibe uma lista com todas as chaves criadas, incluindo:

• Nome ou descrição da chave.
• Data de criação.
• Botões de ação (copiar, editar, excluir).

3. Criando uma nova chave de API

1. Clique no botão Nova Chave de API.
2. Informe um nome descritivo para identificar a finalidade da chave (ex: "Integração ERP", "Sistema de RH").
3. Clique em Salvar.
4. A chave gerada será exibida. Copie e armazene a chave em local seguro — ela não será exibida novamente após fechar a janela.

4. Copiando uma chave existente

1. Na lista de chaves, localize a chave desejada.
2. Clique no ícone de copiar ao lado da chave.
3. A chave será copiada para a área de transferência.

5. Editando uma chave

1. Clique no ícone de edição (lápis) na linha da chave.
2. Atualize o nome ou descrição.
3. Clique em Salvar.

6. Excluindo uma chave

1. Clique no ícone de lixeira na linha da chave que deseja remover.
2. Confirme a exclusão.

Atenção: ao excluir uma chave, qualquer integração que a utilize deixará de funcionar imediatamente. Certifique-se de atualizar os sistemas que usam essa chave antes de excluí-la.

7. Boas práticas de segurança

• Crie uma chave separada para cada sistema ou integração.
• Nunca compartilhe chaves de API em código-fonte público ou e-mails.
• Revise periodicamente as chaves existentes e exclua aquelas que não são mais utilizadas.
• Se uma chave for comprometida, exclua-a imediatamente e crie uma nova.

8. Documentação da API (Swagger)

Para visualizar os endpoints disponíveis e testar a API interativamente:

1. Acesse Minha Empresa.
2. Clique no botão Acesso à API (Swagger).
3. A documentação interativa será aberta em uma nova aba.
4. Use sua chave de API para autenticar as requisições no Swagger.