Comece por aqui: credenciais para integrar com a API da Engage

Toda integração com a API da Engage começa aqui. Em cerca de 15 minutos você reúne as seis credenciais de acesso, confirma que elas funcionam e deixa o Postman pronto para os próximos artigos da série.

O que você precisa

• Instância da sua empresa ativa na Engage, com assinatura vigente.
• Um usuário com acesso de administrador na plataforma.
• Postman instalado no seu computador.

Ambientes

As seis credenciais

Como obter cada credencial

1customer_id

É o identificador da instância da sua empresa. Há duas formas de encontrá-lo:

• No endereço da plataforma: se você acessa https://suaempresa.engage.bz, o customer_id é suaempresa.
• Na tela de login: em https://one.engage.bz, é o valor digitado no campo de identificação da empresa.

2username e password

Crie um usuário de serviço: um usuário da plataforma dedicado à integração, com perfil de administrador. Não use o login de uma pessoa — quando ela sair da empresa, a integração para junto.

O cadastro completo, passo a passo, está em "Criar o usuário de serviço da integração".

3client_id e client_secret

Representam o sistema que vai conversar com a Engage. Para criá-los:

1. Na área administrativa, abra Outras Configurações › Integrações.
2. Em Integre com o Engage, clique no botão de acesso.
3. Clique em + integração engage.
4. Informe o Nome e o Client ID — um identificador curto e estável, como meusistema.
5. Clique em confirmar. A plataforma gera o client_secret automaticamente.

4customer_token

É um código público da instância, com 32 caracteres. Ele não autentica ninguém: indica de qual instância a chamada fala. Você o obtém automaticamente no teste da próxima seção, que chama:

GET https://sandbox.engage.bz/api/v1/{customer_id}/infos/token

O campo token da resposta é o customer_token. A resposta traz também platform_url, o endereço da plataforma da sua instância.

Testar no Postman

Os dois arquivos anexos a este artigo trazem todas as chamadas da série prontas — você só preenche as suas credenciais.

1. Baixe os anexos no fim desta página: Engage-APIs.postman_collection.json (a coleção) e Engage-APIs.postman_environment.json (as variáveis, vazias).
2. No Postman, clique em Import e selecione os dois arquivos de uma vez.
3. No canto superior direito, selecione o Environment Engage - APIs (preencher).
4. Preencha a variável customerId com o seu customer_id. Mantenha baseUrl em homologação.
5. Abra a pasta 01 - Comece aqui, request Token da instância (smoke test), e clique em Send.
   

Agora preencha as demais variáveis — clientId, clientSecret, adminUser e adminPass — sempre na coluna Current value, que fica só no seu computador e não é compartilhada.

Boas práticas de segurança

• Uma aplicação, um par de credenciais. Cada sistema integrado deve ter client_id e client_secret próprios, para que um possa ser revogado sem afetar os outros.
• Envie sempre o client_secret. Em alguns cadastros a chamada funciona sem ele — o teste passa e a integração falha depois, em outra instância.
• Credenciais não viajam junto da documentação. Senhas e segredos vão por canal seguro, em mensagem separada — nunca por e-mail.
• Vazou? Peça a troca do client_secret e altere a senha do usuário de serviço imediatamente.

Problemas comuns

Erros de login, senha ou bloqueio do usuário estão em "Criar o usuário de serviço da integração". A pasta 98 - Erros comuns da coleção traz o catálogo completo e três chamadas de diagnóstico.