API Reference

šŸ‘¤ UsuĆ”rios

Esta seção da API pública permite criar e excluir usuÔrios dentro de uma plataforma. As operações são autenticadas via token e acessadas por integradores confiÔveis, como plataformas de terceiros, automações internas ou integrações com CRMs.


šŸ“Œ Funcionalidades disponĆ­veis

MétodoEndpointDescrição
POST/usersCria um novo usuƔrio
DELETE/usersDeleta um usuƔrio existente com base no e-mail

šŸ” Autenticação e CabeƧalhos

Todas as chamadas exigem um token de API no cabeƧalho:

Authorization: Bearer {SEU_TOKEN_AQUI}
X-Requested-With: XMLHttpRequest
Content-Type: application/json

O token Ć© gerado pelo administrador da plataforma e pode ser regenerado a qualquer momento.


šŸ“ Criar usuario(POST /users)

Parâmetros esperados:

CampoTipoObrigatórioDescrição
full_namestringāœ… SimNome completo do usuĆ”rio
emailstringāœ… SimE-mail Ćŗnico dentro da plataforma
phonestringāŒ OpcionalNĆŗmero com DDD ou DDI
passwordstringāŒ OpcionalSenha em texto

Notificação por E-mail

Ao criar um usuario com sucesso na plataforma um email de boas vindas serƔ enviado ao usuƔrio:

  • Caso o campo password nĆ£o seja informado, no email terĆ” um link para criar uma senha
  • O envio Ć© automĆ”tico e nĆ£o exige nenhuma ação adicional na chamada.
  • O e-mail só serĆ” enviado se o usuĆ”rio possuir um endereƧo de e-mail vĆ”lido.

🧹 Deletar usuÔrio (DELETE /enrollments)

Parâmetros esperados:

CampoTipoDescrição
emailstringE-mail Ćŗnico dentro da plataforma

🧠 Observações

  • A normalização do telefone Ć© feita automaticamente no padrĆ£o brasileiro.
  • Caso um email jĆ” cadastrado seja utilizado na criação de um novo usuĆ”rio, serĆ” retornado um erro de validação informando que o e-mail jĆ” estĆ” em uso.
  • O campo full_name Ć© dividido em first_name e last_name internamente.
  • O campo username Ć© gerado com base no e-mail e garantido como Ćŗnico.
  • Caso o campo password nĆ£o seja fornecido, uma senha aleatória serĆ” criada e uma email serĆ” enviado para o usuario criar uma senha.
  • Ao deletar um usuĆ”rio, o email continua indisponivel para cadastro.