Para que você consiga consumir as API's da Engage, é necessário que a instância do cliente (customerId) esteja ativa na plataforma da Engage e com sua assinatura vigente.

Via de regra, as API's da Engage requerem que a requisição efetuada contenha o access_token de usuário administrador no header visando garantir a segurança dos dados do cliente. Os parâmetros necessários para se gerar o token de acesso que permitirá o consumo dos serviços são:

• customer_id: ID da instância do cliente, ou seja, o ambiente do cliente.
  
• username: Representa o Login do usuário de serviço ou do usuário integrador
• password: Senha do usuário de serviço ou do usuário integrado;
• customer_token: Token da instância do cliente contendo 32 caracteres;
• client_id: ID da aplicação que o cliente deverá registrar na plataforma;
• client_secret: Senha da aplicação registrada na plataforma.

Para desenvolvimento e testes de integração com a plataforma Engage, é disponibilizada abaixo a URL do ambiente de homologação:

2. Ambiente de Produção

• https://my.engage.bz/api/v1/

3. Gerando os parâmetros necessários para utilizar as APIs da Engage 

A seguir detalharemos passo a passo como gerar cada um destes parâmetros.

3.1. O parâmetro customer_id

    O customer_id nada mais é que o ID da empresa que você informa no campo abaixo, identificando qual é seu ambiente ou através do subdomínio de seu ambiente (EX: https://{customer_id}.engage.bz) 

Forma 1: Informando o ID da empresa no endereço padrão da plataforma https://one.engage.bz 

Forma 2: Através do subdomínio de seu ambiente https://{customer_id}.engage.bz

3.2. Gerando os parâmetros username e password (Credenciais do usuário de serviço)

1. Acesse a plataforma da Engage com um usuário que tenha permissão de administrador;
2. Na área administrativa da plataforma, acesse a opção Usuários e, em seguida clique no botão + usuário;
3. Na tela de cadastro do novo usuário, na aba Básico preencha os campos informados, porém atente-se ao campo login. Este deverá apresentar o seguinte formato: integracao{customerId}, ou seja, se o ID da instância é meuprojeto o campo login do usuário de serviço deverá ser cadastrado com o valor integracaomeuprojeto, conforme exemplo abaixo:
4. No campo senha, preencha a senha. É fortemente recomendado que essa senha possua uma mesclagem de caracteres maiusculos, minusculos, números e caracteres especiais;
5. Na aba Avançado, no campo Acesso a área administrativa, selecione a opção Administrador;
6. No campo Perfil administrador, marque o perfil Administrador;
   
7. Clique no botão confirmar e seu usuário de serviço estará criado. Ao término deste procedimento, você terá em mãos os parâmetros username e password que são utilizados em processos de integração com a API da Engage.
   

Importante:

• Usuários de serviço não podem ser utilizados para logar na plataforma, ou seja, caso tente-se logar na plataforma o acesso (login) não funcionará. Estes usuários só podem ser utilizados em processos de integração.
• Caso seja necessário fazer o reset da senha do usuário de serviço, esta ação poderá ser feita através da tela de Gerenciamento de Usuários, na área administrativa da plataforma. 

3.3. Gerando os parâmetros client_id e client_secret

    Os parâmetros client_id e client_secret representam a aplicação que será integrada a plataforma Engage. Como boa prática, é recomendado que cada aplicação que se integrar à Engage tenha ter um client_id e um client_secret especifícico para que seja possível desativá-las individualmente em cada de não utilizá-la mais.

    Para registrar uma nova aplicação na Engage, siga os passos a seguir:

1. Acesse o menu da área Administrativa, opção Outras Configurações e clique na opção Integrações. Localize a opção Integre com o Engage e clique neste botão;
2. Clique no botão "+ integracao engage";
3. Será exibida a tela Nova integração. Informe os campos Nome e o Client ID, conforme exemplo abaixo: 
4. Clique no botão confirmar;
5. Nesse momento o sistema terá gerado o client_secret para sua aplicação:
6. Ao término deste procedimento, você terá em mãos os parâmetros client_id e client_secret que são utilizados em processos de integração com a API da Engage.

3.4. Obtendo o parâmetro customer_token

    Por fim, para que seja possível obter o customer_token de sua instância, basta que você execute a seguinte API no browser ou no Postman 

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

Onde: 

• {ambiente} é o ambiente da API que será utilizado, sendo:
  • sandbox - Ambiente de homologação recomendado para desenvolvimento e testes da integração
  • my - Ambiente de produção e não recomendado para desenvolvimento para evitar comprometer a integridade dos dados da instância do cliente
• {customer_id} é o ID da instância do cliente, já detalhado neste documento.  
  

O parâmetro token representa o customer_token que deverá ser enviado em processos se integração sempre que for necessário.

    Por fim, é extremamente recomendado que os testes e desenvolvimento da integração sejam feitos utilizando nosso ambiente de HOMOLOGAÇÃO. Aponte a integração para o ambiente produtivo da Engage somente quando ela estiver concluída, testada e homologada.