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étodo | Endpoint | Descrição |
---|---|---|
POST | /users | Cria um novo usuƔrio |
DELETE | /users | Deleta 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
)
POST /users
)Parâmetros esperados:
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
full_name | string | ā Sim | Nome completo do usuĆ”rio |
email | string | ā Sim | E-mail Ćŗnico dentro da plataforma |
phone | string | ā Opcional | NĆŗmero com DDD ou DDI |
password | string | ā Opcional | Senha 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
)
DELETE /enrollments
)Parâmetros esperados:
Campo | Tipo | Descrição |
---|---|---|
email | string | E-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 emfirst_name
elast_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.