Esta é a porta de entrada da documentação da API da Engage. Os artigos estão na ordem em que uma integração costuma ser construída: primeiro as credenciais e a autenticação, depois usuários, relatórios e acesso por SSO.
Neste artigo
- Primeiros passos
- Usuários e grupos
- Relatórios
- SSO e acesso
- Ambientes
Dica
Comece pelo primeiro artigo. Ele traz a coleção do Postman com todos os exemplos prontos para testar em homologação.
Primeiros passos
| Artigo | Para que serve |
|---|---|
| Comece por aqui: credenciais para integrar com a API da Engage | Reunir as credenciais e baixar a coleção do Postman |
| Registrar a aplicação de integração pela API | Criar o client_id e o client_secret da integração |
| Criar o usuário de serviço da integração | Cadastrar o usuário que a integração usa para se autenticar |
| Passo 2 — Obtendo o access_token (POST /auth) | Gerar o token que vai em todas as chamadas |
| Passo 2.1 — access_token, refresh_token e customer_token: qual é qual | Renovar o acesso e entender cada token |
Usuários e grupos
| Artigo | Para que serve |
|---|---|
| Integração de usuários: criar e atualizar | Cadastrar e atualizar usuários em lote |
| Consultar usuário | Conferir o que foi gravado e listar usuários |
| Campos adicionais do usuário | Preencher cargo, matrícula, unidade e outros campos da instância |
| Vincular usuário a grupo | Incluir, mover e remover usuários de grupos |
Relatórios
| Artigo | Para que serve |
|---|---|
| Relatórios disponíveis e seus filtros | Descobrir os relatórios da instância e o identificador de cada um |
| Parâmetros de filtro dos relatórios | Recortar o relatório por período, ambiente, usuário e outros |
| Consumir um relatório pela API | Executar o relatório e receber os dados em JSON |
| Relatório no Power Query (Excel e Power BI) | Levar o relatório para o Excel ou o Power BI com atualização automática |
SSO e acesso
| Artigo | Para que serve |
|---|---|
| SSO — Passo 1: ligar o usuário do seu sistema ao usuário da Engage | Registrar o identificador de cada usuário (De/Para) |
| SSO — Passo 2: obter a chave de entrada (custom_sso) | Trocar o identificador por uma chave de entrada |
| SSO — Passo 3: levar o usuário ao portal | Abrir o portal com o usuário já autenticado |
| Outras formas de SSO | SAML, Microsoft Entra ID, Google e página de login própria |
| Acessar conteúdo hospedado em outro sistema (sem novo login) | Abrir, de dentro da Engage, um treinamento que fica em outra plataforma |
Ambientes
| Ambiente | Endereço da API |
|---|---|
| Homologação — use para desenvolver e testar | https://sandbox.engage.bz/api/v1 |
| Produção — só depois de homologado | https://my.engage.bz/api/v1 |
Importante
Homologação e produção têm cadastros separados. As credenciais de um ambiente não funcionam no outro.
Precisa de ajuda?
Escreva para meajuda@engage.bz informando o customer_id, o ambiente e o artigo que você está seguindo. Nunca envie senhas, tokens ou o client_secret por e-mail.
Este artigo foi útil?
Que bom!
Obrigado pelo seu feedback
Desculpe! Não conseguimos ajudar você
Obrigado pelo seu feedback
Feedback enviado
Agradecemos seu esforço e tentaremos corrigir o artigo