Escopo: orientar fornecedores a criarem uma tela personalizada de auto‑cadastro.

1) Modelos de front suportados

• Modelo padrão (nativo): utiliza as telas do Engage. Artigo: Configurações - Autocadastro.
• Modelo personalizado (este guia): criação de um HTML próprio com formulário que envia os parâmetros obrigatórios diretamente para o endpoint de auto‑cadastro do Engage.

No modelo personalizado, o fornecedor cria um HTML com formulário e realiza um POST com os campos listados na seção 2.

2) API obrigatória e parâmetros

Endpoint (POST)

https://my.engage.bz/autoRegister/Default.aspx

Parâmetros obrigatórios (name=...)

Parâmetros opcionais

Observações

• A Chave de Acesso deve existir, estar ativa e com escopo correto (ambiente/trilha/grupo) e, se desejado, com política de ativação automática.
• O formulário personalizado não envia parâmetro de status; a ativação depende de configurações (seção 4).

3) Fluxo detalhado (mínimo)

1. Gerar e configurar a Chave de Acesso: defina escopo, vigência e, se aplicável, ativação automática.
2. Criar o HTML personalizado: incluir os parâmetros obrigatórios e os opcionais desejados; estilizar conforme o branding do cliente.
3. Enviar o formulário via POST para o endpoint acima.
4. Tratar o retorno: usar engageform_redirecturl (sucesso) e engageform_error_redirecturl (falha).
5. Testar: cadastro feliz, login duplicado, e‑mail inválido, política de senha e chave inválida/expirada.

4) Como criar usuário ativo sem validação

No fluxo via formulário (personalizado), a ativação não é controlada por parâmetro do formulário. Ela depende de configuração da instância e/ou da Chave de Acesso:

• Ativação automática por instância: quando habilitada, cadastros via filled_form_user já nascem ativos.
• Ativação automática pela Chave de Acesso: configure a chave para dispensar aprovação. O usuário criado via formulário entra ativo e matriculado conforme o escopo da chave.
• Fluxo com aprovação por token (quando a política exigir): se a ativação automática não estiver habilitada, o cadastro fica aguardando aprovação e é liberado por link de aprovação ou ação administrativa.

Resumo: o formulário envia apenas os campos da seção 2. Se a instância e/ou a chave estiverem configuradas para ativação automática, o usuário entra ativo; caso contrário, segue aprovação por token.

5) Habilitar o auto‑cadastro na instância (Configurações)

Para utilizar o auto‑cadastro, habilite nas Configurações da instância (Página de Login):

1. Acesse Configurações.
2. Na seção Página de Login (final da página), habilite a opção Auto‑cadastro de usuários.
3. (Opcional) Personalize o redirecionamento após auto‑cadastro informando a URL de destino.
4. (Opcional) Configure a URL da página de auto‑cadastro caso deseje apontar para o seu HTML personalizado.

Essas opções controlam a disponibilidade do fluxo e o comportamento de redirecionamento.

6) Criar usuário ativo sem confirmação de e‑mail (Configurações)

Para que o usuário não precise confirmar e‑mail no primeiro acesso:

1. Acesse Configurações → Segurança.
2. Na seção Autenticação, desabilite a opção “Habilitar confirmação de e‑mail no primeiro acesso do usuário”.
3. Salve as alterações.

Com isso, cadastros efetuados via formulário de auto‑cadastro entrarão ativos (desde que a política de ativação automática esteja habilitada conforme a seção 4).

7) Exemplo mínimo de HTML (genérico)

<meta charset="utf-8">
<form action="https://my.engage.bz/autoRegister/Default.aspx" method="POST">
  <input type="hidden" name="engageform_enrollmentkey" value="UUID-DA-CHAVE">
  <input type="hidden" name="engageform_usertype" value="filled_form_user">
  <input type="hidden" name="engageform_redirecturl" value="https://tenant.engage.bz">
  <input type="hidden" name="engageform_error_redirecturl" value="https://seusite.com/cadastro-erro">
  <input type="hidden" name="engageform_cookieduration" value="5">

  <label>Nome completo</label>
  <input type="text" name="engageform_fullname" required>

  <label>E‑mail</label>
  <input type="email" name="engageform_email" required>

  <label>Identificador (somente números)</label>
  <input type="text" name="engageform_login" required>

  <label>Senha</label>
  <input type="password" name="engageform_password" required>

  <button type="submit">Cadastrar</button>
</form>

8) Validações e segurança mínimas

• Front: máscara/validação para identificador numérico, formato de e‑mail e política de senha.
• Segurança: HTTPS em todo o fluxo e redirecturl/error_redirecturl apontando para domínios confiáveis.
• Privacidade: exibir termos/política quando aplicável (LGPD/GDPR).