Skip to main content
As API keys permitem que você autentique requisições à API Jelou a partir de aplicativos ou serviços externos. Com elas você pode enviar mensagens, gerenciar campanhas, consultar conversas e muito mais, de forma programática.

Acessando as API Keys

Para gerenciar suas API keys, vá em Configurações > API Keys no menu lateral.
Você verá uma tabela com todas as API keys existentes na sua conta, incluindo:
  • Chave: Identificador parcialmente oculto da chave
  • Data de criação: Quando foi gerada
  • Ações: Opções disponíveis para cada chave

Criar uma API key

1

Iniciar a criação

Clique no botão Criar localizado no canto superior direito da página.
2

Confirmar a criação

Uma caixa de diálogo de confirmação será exibida. Clique em Criar para gerar a nova chave.
3

Copiar sua chave

A chave gerada será exibida na tela. Use o botão de cópia para salvá-la na área de transferência.
A chave é exibida apenas uma vez. Copie-a e armazene-a em um lugar seguro antes de fechar a caixa de diálogo. Se você a perder, precisará criar uma nova.

Excluir uma API key

Para excluir uma chave que você não precisa mais, clique no ícone de excluir (lixeira) na coluna Ações da chave correspondente. Uma caixa de diálogo de confirmação será exibida antes de prosseguir.
Excluir uma API key é uma ação irreversível. Qualquer integração que use essa chave deixará de funcionar imediatamente. Verifique se nenhum serviço ativo depende da chave antes de excluí-la.

Usar sua API key

Inclua a API key no cabeçalho x-api-key das suas requisições HTTP:
Consulte a referência da API para ver todos os endpoints disponíveis.

Boas práticas

  • Não compartilhe chaves em repositórios públicos ou mensagens. Use variáveis de ambiente para armazená-las.
  • Rotacione suas chaves periodicamente. Crie uma nova chave, atualize suas integrações e exclua a antiga.
  • Use uma chave por integração. Se uma chave for comprometida, você pode revogá-la sem afetar outros serviços.