Register User API (Cadastro de Usuário)
A API de Cadastro de Usuário é uma API que simula a validação e cadastro de um usuário. Ela é utilizada pelo Mini Projeto Formulário Dinâmico com React Hook Form e Zod .
Trata-se de um único endpoint que irá validar dados pessoais de um suposto usuário de uma aplicação.
Autenticação
A API de pedidos do Codante.io não requer autenticação para acessar os pedidos.
Rate Limit
A API de Cadastro de Usuário do Codante.io possui um limite de taxa de 100 solicitações por minuto. Se você exceder esse limite, receberá um código de status 429. O uso indiscriminado também poderá levar ao bloqueio do seu IP.
Base URL
A URL base para a API de pedidos do Codante.io é https://apis.codante.io/api/register-user
.
Cadastro de Usuário
Este é o único endpoint da API e irá validar os dados de cadastro bem como simular um cadastro caso os dados estejam corretos.
Caso os dados estejam corretos, a API retornará um objeto JSON com a mensagem User registered.
bem como os dados do usuário cadastrado em um objeto user
. Caso contrário, a API retornará erro 422
.
Importante notar que a API demora de 1 a 3 segundos para responder para simular uma situação real de uma requisição a um servidor lento.
Atributos obrigatórios
- Name
name
- Type
- string
- Description
Nome completo do usuário.
- Name
email
- Type
- string
- Description
Email do usuário.
- Name
password
- Type
- string
- Description
Senha do usuário.
- Name
password_confirmation
- Type
- string
- Description
Confirmação da senha do usuário. Deve ser igual à senha. Deverá ter no mínimo 8 caracteres.
- Name
cpf
- Type
- string
- Description
CPF do usuário. Deverá ser um CPF válido no formato
000.000.000-00
.
- Name
phone
- Type
- string
- Description
Telefone do usuário. Deverá ser um telefone no formato
(00) 00000-0000
.
- Name
zipcode
- Type
- string
- Description
CEP do usuário. Deverá ser um CEP válido no formato
00000-000
.
- Name
address
- Type
- string
- Description
Endereço do usuário.
- Name
city
- Type
- string
- Description
Cidade do usuário.
- Name
terms
- Type
- boolean
- Description
Aceite dos termos de uso.
Request
curl -X POST https://apis.codante.io/api/register-user/register \
-H "Content-Type: application/json" \
-d '{
"name": "Benjamin Pacheco",
"email": "[email protected]",
"password": "123456",
"password_confirmation": "123456",
"cpf": "123.456.789-00",
"phone": "(11) 99999-9999",
"zipcode": "12345-678",
"address": "Rua Teste",
"city": "São Paulo",
"terms": true
}'
Response
{
"message": "User registered.",
"user": {
"name": "João Silva",
"email": "[email protected]",
"password": "senhaSegura123",
"password_confirmation": "senhaSegura123",
"terms": true,
"phone": "11987654321",
"cpf": "350.519.788-27",
"zipcode": "12345-670",
"address": "Rua Exemplo, 123",
"city": "Cidade Exemplo"
}
}