API.md

POST /auth/new

Utilize este método para obter os tokens de acesso utilizando e-mail e senha fornecidos

Payload:

{
	"email": string,
	"password": string
}

Response:

{
	"access_token": string,
	"refresh_token": string
}

POST /auth/refresh

Utilize este método para renovar um token de acesso expirado

Payload:

{
	"refresh_token": string
}

Response:

{
	"access_token": string
}

GET /people

Utilize este método para visualizar a lista de pessoas cadastradas na plataforma

Query Parameters:

• page: Página que deve retornar (default: 1)
• pageSize: Quantidade de leilões que deve ser retornado (default: 5, max: 10)
• name: Nome do leilão para filtro

Response:

{
	"hasNext" : boolean,
	"people": [
		{
			"_id": string,
			"name": string,
			"photo": string (Image URI)
		}
	]
}

GET /people/me

Utilize este método para visualizar os dados do seu usuário na plataforma

Response:

{
        "_id": string,
        "name": string,
        "photo": string (Image URI)
}

PUT /people/me

Utilize este método para alterar os dados do seu usuário na plataforma

Payload:

{
        "name": string,
        "photo": string (Image URI)
}

Response:

{
        "_id": string,
        "name": string,
        "photo": string (Image URI)
}

GET /people/:id/testimonials

Utilize este método para visualizar os depoimentos de uma pessoa (identificada pelo :id)

Query Parameters:

• page: Página que deve retornar (default: 1)
• pageSize: Quantidade de leilões que deve ser retornado (default: 5, max: 10)

Response:

{
	"hasNext" : boolean,
	"testimonials": [
		{
			"_id": string,
			"status": (1 = pending, 2 = approved),
			"text": string
		}
	]
}

POST /people/:id/testimonials

Utilize este método para criar um depoimentos para uma pessoa (identificada pelo :id)

Payload:

{
    "status": (1 = pending, 2 = approved),
    "text": string
}

Response:

{
    "_id": string,
    "status": (1 = pending, 2 = approved),
    "text": string
}

PUT /testimonials/:testimonial_id

Utilize este método para alterar um depoimento (identificado pelo testimonial_id). Você só pode alterar depoimentos feitos para o seu usuário.

Payload:

{
    "status": (1 = pending, 2 = approved)
}

Response:

{
    "_id": string,
    "status": (1 = pending, 2 = approved),
    "text": string
}

DELETE /testimonials/:testimonial_id

Utilize este método para excluir um depoimento (identificado pelo testimonial_id). Você só pode excluir depoimentos feitos para o seu usuário.

Response:

204 No Content