Com a key do Passo 2, o seu sistema leva o usuário para o portal da Engage já autenticado. É só um redirecionamento: você monta a URL de entrada e envia o usuário para ela.
Neste artigo
- Antes de começar
- Levar o usuário ao portal
- Cuidados
- Problemas comuns
Antes de começar
- Uma
keyobtida agora no SSO — Passo 2: obter a chave de entrada (custom_sso). - O endereço do portal da sua instância, que vem do campo
platform_url— veja a Etapa 1. - Teste em homologa��ão:
https://sandbox.engage.bz/api/v1.
Levar o usuário ao portal
1Descubra o endereço do portal
GET https://sandbox.engage.bz/api/v1/{customer_id}/infos/tokenA chamada não precisa de autenticação. A resposta traz o campo platform_url, que pode vir em dois formatos:
| Formato | Exemplo |
|---|---|
| Domínio próprio da instância | https://cursos.suaempresa.com.br |
| Endereço geral da Engage, com caminho | https://one.engage.bz/#/loginform?customerId=minhaempresa |
Use só o começo do endereço: o protocolo e o domínio (https://cursos.suaempresa.com.br ou https://one.engage.bz). Descarte o que vier depois do domínio.
No Postman: pasta 04 - SSO e identificadores, request Instância — platform_url e customer_token. O script guarda o protocolo e o domínio na variável platformUrl.
Importante
Não fixe o endereço do portal no seu código. Leia o platform_url da instância: ele muda quando a instância passa a usar um domínio próprio, e homologação e produção têm endereços diferentes.
2Redirecione o usuário
Monte a URL de entrada com o domínio da Etapa 1 e a key:
https://one.engage.bz/#/login?key={key}No aplicativo da Engage, a URL de entrada é:
engageone:///#/login?key={key}No Postman, o request SSO — obter a key (custom_sso) já monta essa URL na variável ssoLoginUrl, sem imprimir a key.
Cuidado
A URL de entrada é o acesso do usuário: quem tiver o endereço entra como ele. Gere a key no momento do clique, redirecione na hora e não grave a URL em log, histórico ou e-mail. Use sempre HTTPS.
3Encerre a sessão quando precisar
DELETE https://sandbox.engage.bz/api/v1/logout/{key}No Postman: request SSO — encerrar a sessão (logout).
Cuidados
- Redirecione, não abra em iframe. O fluxo é uma navegação do usuário para o portal.
- A
keynão é descartada no primeiro uso. Ela vale enquanto a sessão estiver ativa — é isso que mantém o usuário logado quando ele atualiza a página. O que invalida a chave é o logout ou um novo login do mesmo usuário, na mesma aplicação e no mesmo dispositivo. - A sessão dura o
expires_indo Passo 2. O tempo é definido no cadastro da aplicação. - Uma chave por acesso. Não reaproveite a mesma
keypara outro usuário nem em outra máquina: o login novo derruba o anterior. - Não use
GET /login/{key}para validar a sessão. É a rota que o próprio portal usa para trocar a chave pela sessão, e ela responde HTTP 200 mesmo com a sessão já vencida.
Problemas comuns
| O que aparece | Causa provável | O que fazer |
|---|---|---|
| O portal volta para a tela de login | A chave não vale mais: houve logout, ou um novo login derrubou a sessão | Gere uma key nova no Passo 2 e redirecione de novo |
| Entra, mas cai para a tela de login logo depois | A sessão venceu antes de o usuário abrir a URL | Gere a key no momento do clique, não antes |
| Página não encontrada ou erro de rota ao abrir o portal | URL montada com o platform_url inteiro, ou com um domínio fixo errado | Use só o protocolo e o domínio do platform_url e acrescente /#/login?key={key} |
platform_url vazio, ou {"result": null} na Etapa 1 | customer_id errado, instância inativa ou endereço do portal não configurado | Confira o customer_id. Se o erro continuar, fale com o Suporte |
Próximo passo
Para entrada por SAML, Microsoft Entra ID ou Google, veja Outras formas de SSO.
Precisa de ajuda?
Escreva para meajuda@engage.bz informando o customer_id, o ambiente e o que aparece na tela ao abrir a URL — sem a key. Nunca envie senhas, tokens, a key 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