API Keys - Como Criar e Gerenciar Chaves de Acesso para Integrações no Berga
Aprenda a criar e gerenciar API Keys no Berga para integrar sistemas externos como PDV, ERP ou outras ferramentas. Veja como gerar uma chave, copiá-la com segurança logo após a criação, revogar chaves que não são mais necessárias e boas práticas para controlar o acesso de cada integração separadamente.
A página de API Keys permite criar e gerenciar chaves de acesso para integrar sistemas externos ao Berga, como um Ponto de Venda, um sistema de gestão próprio ou qualquer outra ferramenta que precise se comunicar com a sua conta. Cada chave gerada é única e funciona como uma senha de acesso para o sistema externo.
Clique para ir a Página: API Keys
Como Acessar
No menu lateral, acesse Configurações e depois API Keys. O acesso a esta página requer permissão de configurações. Caso o item não apareça no menu, verifique com o administrador do sistema se o seu perfil de acesso inclui essa permissão.
Visão Geral da Página
A página exibe uma tabela com todas as chaves cadastradas na empresa. As colunas exibidas são:
- Status: indicador colorido mostrando a situação da chave. Um círculo verde indica que a chave está ativa; um círculo cinza indica que foi revogada
- Nome: nome descritivo dado à chave no momento da criação
- Último uso: data e hora do último acesso feito com aquela chave. Exibe "Nunca utilizada" quando a chave nunca foi usada
- Criada em: data em que a chave foi gerada
Pressione a tecla N para abrir o formulário de criação de uma nova chave.
Quando não há nenhuma chave cadastrada, a página exibe a mensagem "Nenhuma API Key cadastrada" com uma orientação para criar a primeira chave.
Filtros de Pesquisa
Use os filtros no topo da tabela para localizar chaves específicas:
- Buscar: filtra pelo nome da chave enquanto você digita
- Status: filtra por Todos, Ativa ou Inativa
É possível também ordenar a tabela pelos campos Nome, Criada em e Último uso em ordem crescente ou decrescente.
Como Criar uma Chave
Clique em Nova Chave ou pressione N. A janela "Nova API Key" abre com o seguinte campo:
- Nome: obrigatório. Informe um nome que identifique claramente onde a chave será usada, como "PDV Caixa 01" ou "Integração ERP". O nome pode ter no máximo 100 caracteres
Clique em Gerar Chave ou pressione Enter para criar a chave. Você também pode pressionar Esc ou clicar em Cancelar para fechar a janela sem criar.
Guardando a Chave Gerada
Após a criação, a chave é exibida na mesma janela com um aviso importante: a chave não será exibida novamente depois que você fechar a janela.
Para copiar a chave, clique no botão de cópia ao lado dela. Uma confirmação aparece na tela quando a chave for copiada com sucesso.
Guarde a chave em um local seguro antes de clicar em Concluir. Se a chave for perdida, não é possível recuperá-la e será necessário criar uma nova.
Como Revogar uma Chave
Quando uma chave não é mais necessária ou pode ter sido comprometida, ela deve ser revogada. Ao revogar, qualquer sistema que esteja usando aquela chave perde o acesso imediatamente.
Para revogar, clique no menu de ações (três pontos) na linha da chave e selecione Revogar. Uma janela de confirmação exibe o nome da chave e informa que a ação não pode ser desfeita.
Clique em Confirmar para revogar ou em Cancelar para fechar sem alterar nada. Após a revogação, a chave é removida da lista.
A opção de revogar fica desabilitada para chaves que já estão inativas.
Status das Chaves
Cada chave pode estar em uma das seguintes situações:
- Ativa: a chave está funcionando e pode ser usada para acessar a conta via integração
- Inativa: a chave foi revogada e não permite mais nenhum acesso
Uma chave inativa não pode ser reativada. Caso precise restabelecer o acesso de um sistema que usava uma chave revogada, crie uma nova chave e atualize as configurações do sistema com a nova chave gerada.
Não há limite de chaves na conta. Como cada chave funciona como uma senha, crie uma separada para cada sistema ou integração, com um nome descritivo; assim o controle fica organizado e, ao revogar o acesso de um sistema, os demais continuam funcionando. Revogue imediatamente qualquer chave exposta ou fora de uso e nunca a compartilhe em locais públicos.
Artigos Relacionados
Precisa de Ajuda?
Se tiver dúvidas sobre como usar as API Keys, entre em contato:
-
Telefone: (54) 3321-0214