Guia de integração de Sistemas

O acesso a API é um recurso disponível para desenvolvedores. As informações de acesso são passadas pelo nosso time. Para saber como configurar uma conta teste com acesso a API, entrar em contato com dev@curitibacult.com.br.

Login

Requisição de login normal de acesso aos padrinhos do Curitiba Cult. É retornado um Bearer Token Authentication que deve ser usado nas chamadas seguintes.

Fields Type Required
email String true
password String true

Request

Route
POST https://curitibacult-dashboard-api.herokuapp.com/api/auth/padrinhos/login
Header
Content-Type: application/json
Body
{

"email": "email@teste.com.br",

"password": "***"

}

Response

Status
200
Body
{

"token": "***"

}

Padrinhos

Requisições de acesso exclusivo às informações do Padrinho. Deve ser usado Token coletado no login para busca.

Request

Route
GET https://curitibacult-dashboard-api.herokuapp.com/api/padrinhos
Header
Authorization: 'Bearer XXXX'
Body
{}

Response

Status
200
Body
{

"_id": "XXXX",

"name": "Nome do Padrinho",

"email": "email@teste.com.br",

"cpf": "XXX.XXX.XXX-XX",

"status": "active",

"firstAccess": true,

"entryDate": "YYYY-MM-DDT00:00:00.000Z",

"qrCode": "https://fakeimg.pl/250x250/F37321/fff/?text=curitibacult",

"avatar": "https://fakeimg.pl/250x250/F37321/fff/?text=curitibacult"

}

Request

Route
POST https://curitibacult-dashboard-api.herokuapp.com/api/novo-padrinho-app
Header
Content-Type: application/json
Body
{

"name": "Nome Padrinho",

"email": "email@teste.com.br",

"cpf": "XXX.XXX.XXX-XX",

"phone": "(XX) XXXXX-XXXX",

"password": "***"

}

Response

Status
200
Body
{

"status": "XXX",

"msg": "XXXXX"

}

Request

Route
POST https://curitibacult-dashboard-api.herokuapp.com/api/padrinhos/forgot-password
Header
Content-Type: application/json
Body
{

"email": "email@teste.com.br"

}

Response

Status
200
Body
{}

Request

Route
PUT https://curitibacult-dashboard-api.herokuapp.com/api/padrinhos
Header
Content-Type: multipart/form-data
Authorization: 'Bearer XXXX'
Body
var FormData = require('form-data'); 
var fs = require('fs');
var data = new FormData();

data.append('name', 'Novo Nome do Padrinho');
data.append('password', 'Nova senha do Padrinho');
data.append('avatarImage', fs.createReadStream('/logo-curitibacult-topo.png'));

Response

Status
200
Body
{

"_id": "XXXX",

"name": "Nome do Padrinho",

"status": "active",

"firstAccess": true,

"qrCode": "https://fakeimg.pl/250x250/F37321/fff/?text=curitibacult",

"avatar": "https://fakeimg.pl/250x250/F37321/fff/?text=curitibacult"

}
© Gustavo Troquilho - Todos os direitos reservados.