Toda requisição aos endpoints /v1 deve ser autenticada com uma chave da sua empresa. Você pode gerar quantas chaves precisar — separando integrações, equipes ou ambientes do seu lado.
Gerando uma chave pelo painel
O fluxo recomendado é criar chaves pela interface do Engage:
01
Abra as ConfiguraçõesNo painel do Engage, entre em Configurações e selecione a aba Chaves de API.
02
Clique em Adicionar ChaveUm diálogo abrirá pedindo um nome descritivo para a chave — use algo que identifique onde ela será usada, como “Integração ERP de Produção”.
03
Copie a chave completaAo criar, a chave em claro é exibida uma única vez. Copie com o botão de copiar e guarde em um cofre ou variável de ambiente.
A chave é exibida uma única vez
Depois de fechar o diálogo de criação, só ficará visível o preview com os primeiros caracteres (sk_live_a1b2***…). Se perder a chave, gere uma nova e revogue a antiga.
Formato da chave
Chaves têm 72 caracteres no total, formadas pelo prefixo sk_live_ seguido de 64 caracteres hexadecimais aleatórios (32 bytes de entropia).
O Engage nunca armazena a chave em claro — guardamos apenas um hash SHA-256 dela. Por isso só é possível visualizar a chave completa no momento da criação.
Adicionando a chave na requisição
Envie a chave no header HTTP x-api-key em todas as chamadas aos endpoints /v1:
O Engage usa o header x-api-key, e não Authorization: Bearer. Chaves enviadas no header errado retornam 401.
Possíveis erros
O guard de autenticação retorna 401 Unauthorized em qualquer uma destas situações:
API key not providedO header x-api-key não foi enviado.
Invalid API keyChave inexistente, com formato incorreto ou já revogada.
Company is deactivatedA empresa dona da chave foi desativada no Engage.
Revogando chaves
No painel, clique em Excluir ao lado da chave e confirme no diálogo. A revogação é instantânea — aplicações que estavam usando aquela chave passam a receber 401 Invalid API key na próxima requisição. A ação não pode ser desfeita.