Usuários
Nesta seção estão disponibilizados todos os métodos referentes á usuários desde á importação em massa até uma simples atualização de estado.
Atenção: O {token_da_plataforma} é disponibilizado pelo administrador da plataforma. Ele pode encontrar seu token acessando a dashboard, na página de: Plataforma > Configurações > Token.

Buscando usuário
Busca de usuário por id, e-mail, documento e id de referência.
Busca por ID.
GET
URL_BASE/users/show-id/{id}/{token_do_desenvolvedor}/{token_da_plataforma}
Nesta rota troque o termo {id} pelo id do usuário que deseja buscar.
{
"id": "UUID",
"name": "Novo",
"last_name": "Aluno(a)",
"email": "[email protected]",
"photo_url": null,
"document": "000.000.000-00",
"genre": null,
"birth": null,
"phone": null,
"status": 1,
"created_at": "YYYY-MM-DD H:i:s",
"updated_at": "YYYY-MM-DD H:i:s",
"subscription": {
"id": "0",
"tenant_id": 0,
"active": 1,
"user_id": "UUID",
"package_id": "UUID",
"created_at": "YYYY-MM-DD H:i:s",
"updated_at": "YYYY-MM-DD H:i:s",
}
}
Busca por documento.
GET
URL_BASE/users/show-document/{document}/{token_do_desenvolvedor}/{token_da_plataforma}
Nesta rota troque o termo {document} pelo documento do usuário que deseja buscar.
{
"id": "UUID",
"name": "Novo",
"last_name": "Aluno(a)",
"email": "[email protected]",
"photo_url": null,
"document": "000.000.000-00",
"genre": null,
"birth": null,
"phone": null,
"status": 1,
"created_at": "YYYY-MM-DD H:i:s",
"updated_at": "YYYY-MM-DD H:i:s",
"subscription": {
"id": "0",
"tenant_id": 0,
"active": 1,
"user_id": "UUID",
"package_id": "UUID",
"created_at": "YYYY-MM-DD H:i:s",
"updated_at": "YYYY-MM-DD H:i:s",
}
}
Busca por e-mail.
GET
URL_BASE/users/show-email/{email}/{token_do_desenvolvedor}/{token_da_plataforma}
Nesta rota troque o termo {email} pelo documento do usuário que deseja buscar.
{
"id": "UUID",
"name": "Novo",
"last_name": "Aluno(a)",
"email": "[email protected]",
"photo_url": null,
"document": "000.000.000-00",
"genre": null,
"birth": null,
"phone": null,
"status": 1,
"created_at": "YYYY-MM-DD H:i:s",
"updated_at": "YYYY-MM-DD H:i:s",
"subscription": {
"id": "0",
"tenant_id": 0,
"active": 1,
"user_id": "UUID",
"package_id": "UUID",
"created_at": "YYYY-MM-DD H:i:s",
"updated_at": "YYYY-MM-DD H:i:s",
}
}
Busca por id de referência .
GET
URL_BASE/users/show-reference/{reference_id}/{token_do_desenvolvedor}/{token_da_plataforma}
Nesta rota troque o termo {reference_id} pelo id de referência do usuário que deseja buscar.
{
"id": "UUID",
"name": "Novo",
"last_name": "Aluno(a)",
"email": "[email protected]",
"photo_url": null,
"document": "000.000.000-00",
"genre": null,
"birth": null,
"phone": null,
"status": 1,
"created_at": "YYYY-MM-DD H:i:s",
"updated_at": "YYYY-MM-DD H:i:s",
"subscription": {
"id": "0",
"tenant_id": 0,
"active": 1,
"user_id": "UUID",
"package_id": "UUID",
"created_at": "YYYY-MM-DD H:i:s",
"updated_at": "YYYY-MM-DD H:i:s",
}
}
Criando usuário(s)
Então vamos ao método de criação de usuário(s):
Exemplo de JSON para criação de um ou mais usuários:
Criar um ou mais usuários.
POST
URL_BASE/users/create/{token_do_desenvolvedor}/{token_da_plataforma}
Usar JSON de exemplo que esta logo abaixo.
{
"product_id" : ["123456789"],
"users": [
{
"name": "Aluno",
"last_name":"teste",
"email":"[email protected]", // dado obrigatório
"password": "senhadoalunoopcional", // dado opcional
"document":"123.456.789-10",
"phone":"(11)99999-9999",
"reference_id": "789456123546",
"accession_date" : "YYYY-MM-DD",
},{
"name": "Aluno",
"last_name":"teste",
"email":"[email protected]", // dado obrigatório
"password": "senhadoalunoopcional", // dado opcional
"document":"123.456.789-10",
"phone":"(11)99999-9999",
"reference_id": "789456123546",
"accession_date" : "YYYY-MM-DD",
}
]
}
Exclusão de usuário
Excluir por id.
DELETE
URL_BASE/users/destroy-user-id/{user_id}/{token_do_desenvolvedor}/{token_da_plataforma}
Após a exclusão do usuário a operação não poderá ser revertida.
{
// Response
}
Excluir por documento.
DELETE
URL_BASE/users/destroy-document/{document}/{token_do_desenvolvedor}/{token_da_plataforma}
Após a exclusão do usuário a operação não poderá ser revertida.
{
// Response
}
Excluir por email.
DELETE
URL_BASE/users/destroy-email/{email}/{token_do_desenvolvedor}/{token_da_plataforma}
Após a exclusão do usuário a operação não poderá ser revertida.
{
// Response
}
Excluir por id de referência.
DELETE
URL_BASE/users/destroy-reference-id/{reference_id}/{token_do_desenvolvedor}/{token_da_plataforma}
Após a exclusão do usuário a operação não poderá ser revertida.
{
// Response
}
Last updated