Skip to content

estartandodevs-course/doae-backend

BranchesTags

Repository files navigation

Doaê

Introdução

Este documento tem como finalidade especificar as funcionalidades, regras de negócio utilizadas no projeto, tecnologias a serem utilizadas, metodologias de desenvolvimento, arquitetura, meios de comunicação da equipe, definição das tarefas principais e as prioridades.

Doaê conecta pessoas que buscam fazer doações para as melhores ONGs com causas em que acreditam, que demonstram com transparência onde aplicam suas arrecadações. Pois, através da nossa plataforma, o usuário pode ter acesso a informações e novidades de cada ONG parceira, receber notícias, saber o andamento dos projetos das instituições e, principalmente, ajudar de forma realmente impactante!

Rodando a API

# Clone este repositório
$ git clone https://github.com/estartandodevs-course/doae-backend.git

# Acesse a pasta do projeto no terminal/cmd
$ cd doae-backend

# Instale as dependências
$ npm install

# Execute a aplicação em modo de desenvolvimento
$ npm start

# Nosso servidor está no ar no link
$ https://doae-api.onrender.com/

Formato da resposta

Resposta da API JSON
Métodos aceitos GET

Rotas

Criar instituição:

https:

Parâmetros - Corpo da Requisição

{
	"name": "Lar das moças cegas",
	"email": "[email protected]",
	"cnpj": "58198227000173.",
  "description" : "A proposta do LMC é que a pessoa com deficiência visual receba todo atendimento necessário para habilitação, reabilitação e inclusão dela na sociedade",
  "cep": "11060-000",
  "agency": "2973",
  "count":"04262-1",
  "pix": "[email protected]",
  "phone": "(13) 3226.2760",
  "site": "http://www.lmc.org.br/",
  "logo": "lmc.png",
  "id_external": "lnf-dshn-435",
  "password": "Larmocacega1!"
}

Resposta

{
  "id": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
  "name": "Lar das moças cegas",
	"email": "[email protected]",
	"cnpj": "58198227000173.",
  "description" : "A proposta do LMC é que a pessoa com deficiência visual receba todo atendimento necessário para habilitação, reabilitação e inclusão dela na sociedade",
  "cep": "11060-000",
  "agency": "2973",
  "count":"04262-1",
  "pix": "[email protected]",
  "phone": "(13) 3226.2760",
  "site": "http://www.lmc.org.br/",
  "logo": "lmc.png",
  "id_external": "lnf-dshn-435",
  "password": "Larmocacega1!"
}

Listar instituições

https://

Resposta

[
  {
    "id": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
    "name": "Lar das moças cegas",
	  "email": "[email protected]",
	  "cnpj": "58198227000173.",
    "description" : "A proposta do LMC é que a pessoa com deficiência visual receba todo atendimento necessário para habilitação, reabilitação e inclusão dela na sociedade",
    "cep": "11060-000",
    "agency": "2973",
    "count":"04262-1",
    "pix": "[email protected]",
    "phone": "(13) 3226.2760",
    "site": "http://www.lmc.org.br/",
    "logo": "lmc.png",
    "id_external": "lnf-dshn-435",
    "password": "Larmocacega1!"
  },
];

listar instituição por id

https:

Parâmetros - Corpo da Requisição

{
    "id" : "d1000da0-8921-4b88-9a6d-ccf5c5b473ff"
}

Resposta

{
  "id": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
  "name": "Lar das moças cegas",
	"email": "[email protected]",
	"cnpj": "58198227000173.",
  "description" : "A proposta do LMC é que a pessoa com deficiência visual receba todo atendimento necessário para habilitação, reabilitação e inclusão dela na sociedade",
  "cep": "11060-000",
  "agency": "2973",
  "count":"04262-1",
  "pix": "[email protected]",
  "phone": "(13) 3226.2760",
  "site": "http://www.lmc.org.br/",
  "logo": "lmc.png",
  "id_external": "lnf-dshn-435",
  "password": "Larmocacega1!"
}

Atualizar Instituição

Parâmetros - Corpo da Requisição

{
    "id": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
    "name": "Lar das moças cegas",
    "description" : "A proposta do LMC é que a pessoa com deficiência visual receba todo atendimento necessário para habilitação, reabilitação e inclusão dela na sociedade",
    "agency": "2973",
    "count":"04262-1",
    "pix": "[email protected]",
    "phone": "(13) 3226.2760"
}

Resposta

"Instituição atualizada com sucesso";

Atualizar credenciais da Instituição

Parâmetros - Corpo da Requisição

{
    "id": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
    "email": "[email protected]",
    "password": "Larmocacega1!"
}

Resposta

"Credenciais atualizadas com sucesso";

Atualizar logo da Instituição

Parâmetros - Corpo da requisição

{
    "id": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
    "logo": "lmc.png"
}

Resposta

"Logo atualizada com sucesso";

Excluir Instituição

Parâmetros - Corpo da Requisição

https:

Resposta

"Instituição deletada com sucesso";

Criar meta:

https:

Parâmetros - Corpo da Requisição

{
 	"name" : "cesta básica",
  "value": 300.00,
	"currenty_quantity": 0,
	"id_institution": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
  "description": "Nossa meta é conseguir agraciar uma família com uma cesta básica até o início do próximo mês",
	"day_limit": "22/12/22"
}

Resposta

{
  "id": "jfndsj-435k-kodf54-34245nh",
  "name" : "cesta básica",
  "value": 300.00,
	"currenty_quantity": 0,
	"id_institution": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
  "description": "Nossa meta é conseguir agraciar uma família com uma cesta básica até o início do próximo mês",
	"day_limit": "22/12/22"
}

Listar metas

https://

Resposta

[
  {
    "id": "jfndsj-435k-kodf54-34245nh",
    "name": "cesta básica",
    "value": 300.0,
    "currenty_quantity": 0,
    "id_institution": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
    "description": "Nossa meta é conseguir agraciar uma família com uma cesta básica até o início do próximo mês",
    "day_limit": "22/12/22",
  },
];

listar meta por id

https:

Parâmetros - Corpo da Requisição

{
    "id" : "jfndsj-435k-kodf54-34245nh"
}

Resposta

{
  "id": "jfndsj-435k-kodf54-34245nh",
  "name" : "cesta básica",
  "value": 300.00,
	"currenty_quantity": 0,
	"id_institution": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
  "description": "Nossa meta é conseguir agraciar uma família com uma cesta básica até o início do próximo mês",
	"day_limit": "22/12/22"
}

listar meta por id da instituição

https:

Parâmetros - Corpo da Requisição

{
    "id" : "d1000da0-8921-4b88-9a6d-ccf5c5b473ff"
}

Resposta

{
  "id": "jfndsj-435k-kodf54-34245nh",
  "name" : "cesta básica",
  "value": 300.00,
	"currenty_quantity": 0,
	"id_institution": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
  "description": "Nossa meta é conseguir agraciar uma família com uma cesta básica até início do próximo mês",
	"day_limit": "22/12/22"
}

Atualizar Meta

Parâmetros - Corpo da Requisição

{
  "id": "jfndsj-435k-kodf54-34245nh",
  "name" : "cesta básica",
  "value": 300.00,
}

Resposta

"Meta atualizada com sucesso";

Atualizar quantia atual da meta

Parâmetros - Corpo da Requisição

{
    "id": "jfndsj-435k-kodf54-34245nh",
    "value": 300.00,
    "id_product" : "ifdi43-634fs-jsdi4f-4ndy34"
}

Resposta

"Quantia atualizada com sucesso";

Excluir Meta

Parâmetros - Corpo da Requisição

https:

Resposta

"Meta deletada com sucesso";

Criar Doação:

https:

Parâmetros - Corpo da Requisição

{
	"id_institution" : "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
	"value": 15.00,
	"email_giver": "[email protected]",
	"id_target": "jfndsj-435k-kodf54-34245nh"
}

Resposta

{
  "id": "dsji3-mkn4-3n2jn-nk234",
  "id_institution" : "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
	"value": 15.00,
	"email_giver": "[email protected]",
	"id_target": "jfndsj-435k-kodf54-34245nh",
  "status": "doação realizada"
}

Listar doações

https://

Resposta

[
  {
    "id": "dsji3-mkn4-3n2jn-nk234",
    "id da instituição": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
    "value": 15.0,
    "email_giver": "[email protected]",
    "id_target": "jfndsj-435k-kodf54-34245nh",
    "status": "doação realizada",
  },
];

listar doação por id

https:

Parâmetros - Corpo da Requisição

{
    "id" : "dsji3-mkn4-3n2jn-nk234"
}

Resposta

{
  "id": "dsji3-mkn4-3n2jn-nk234",
  "id_institution" : "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
	"value": 15.00,
	"email_giver": "[email protected]",
	"id_target": "jfndsj-435k-kodf54-34245nh",
  "status": "doação realizada"
}

listar doação por id da instituição

https:

Parâmetros - Corpo da Requisição

{
  "id" : "d1000da0-8921-4b88-9a6d-ccf5c5b473ff"
}

Resposta

{
  "id": "dsji3-mkn4-3n2jn-nk234",
  "id_institution" : "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
	"value": 15.00,
	"email_giver": "[email protected]",
	"id_target": "jfndsj-435k-kodf54-34245nh",
  "status": "doação realizada"
}

listar doação por id da meta

https:

Parâmetros - Corpo da Requisição

{
    "id" : "jfndsj-435k-kodf54-34245nh"
}

Resposta

{
  "id": "dsji3-mkn4-3n2jn-nk234",
  "id_institution" : "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
	"value": 15.00,
	"email_giver": "[email protected]",
	"id_target": "jfndsj-435k-kodf54-34245nh",
  "status": "doação realizada"
}

Atualizar Doação

Parâmetros - Corpo da Requisição

{
  "id": "dsji3-mkn4-3n2jn-nk234",
  "status": "doação realizada"
}

Resposta

"Doação atualizada com sucesso";

Excluir Doação

Parâmetros - Corpo da Requisição

https:

Resposta

"Doação deletada com sucesso";

Criar Produto:

https:

Parâmetros - Corpo da Requisição

{
	"name": "arroz",
	"value": 5.00,
	"id_institution": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff"
}

Resposta

{
  "id" : "dfg43-nuh23-mudssb943-54376d",
  "name": "arroz",
	"value": 5.00,
	"id_institution": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff"
}

listar produto por id

https:

Parâmetros - Corpo da Requisição

{
  "id" : "dfg43-nuh23-mudssb943-54376d"
}

Resposta

{
  "id" : "dfg43-nuh23-mudssb943-54376d",
  "name": "arroz",
	"value": 5.00,
	"id_institution": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff"
}

listar produto por id da instituição

https:

Parâmetros - Corpo da Requisição

{
  "id" : "d1000da0-8921-4b88-9a6d-ccf5c5b473ff"
}

Resposta

{
  "id" : "dfg43-nuh23-mudssb943-54376d",
  "name": "arroz",
	"value": 5.00,
	"id_institution": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff"
}

Atualizar Produto

Parâmetros - Corpo da Requisição

{
  "id": "dfg43-nuh23-mudssb943-54376d",
  "name": "arroz",
  "value": 5.00
}

Resposta

"Protuto atualizado com sucesso";

Excluir Produto

Parâmetros - Corpo da Requisição

https:

Resposta

"Produto deletado com sucesso";

Criar Produto da meta:

https:

Parâmetros - Corpo da Requisição

{
	"id_product": "dfg43-nuh23-mudssb943-54376d",
  "id_target": "jfndsj-435k-kodf54-34245nh"
}

Resposta

{
  "id" : "knfd6-jfnd44-9453nk-843nin",
  "id_product": "dfg43-nuh23-mudssb943-54376d",
  "id_target": "jfndsj-435k-kodf54-34245nh"
}

listar produto da meta por id do produto

https:

Parâmetros - Corpo da Requisição

{
  "id" : "dfg43-nuh23-mudssb943-54376d"
}

Resposta

{
  "id" : "knfd6-jfnd44-9453nk-843nin",
  "id_product": "dfg43-nuh23-mudssb943-54376d",
  "id_target": "jfndsj-435k-kodf54-34245nh"
}

listar produto por id da meta

https:

Parâmetros - Corpo da Requisição

{
  "id" : "jfndsj-435k-kodf54-34245nh"
}

Resposta

{
  "id" : "knfd6-jfnd44-9453nk-843nin",
  "id_product": "dfg43-nuh23-mudssb943-54376d",
  "id_target": "jfndsj-435k-kodf54-34245nh"
}

listar produto por id do produto da meta

https:

Parâmetros - Corpo da Requisição

{
  "id" : "knfd6-jfnd44-9453nk-843nin"
}

Resposta

{
  "id" : "knfd6-jfnd44-9453nk-843nin",
  "id_product": "dfg43-nuh23-mudssb943-54376d",
  "id_target": "jfndsj-435k-kodf54-34245nh"
}

Excluir Produto da meta

Parâmetros - Corpo da Requisição

https:

Resposta

"Produto da meta deletado com sucesso";

Criar Publicação:

https:

Parâmetros - Corpo da Requisição

{
	"description": "Hoje istribuimos cestasn básicas no bairro de Vila Mariana",
  "id_institution": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
  "midia": "arquivo.jpg"
}

Resposta

{
  "id": "hds773-odsfn987-32nju3-864nj",
  "description": "Hoje istribuimos cestasn básicas no bairro de Vila Mariana",
  "id_institution": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
  "midia": "arquivo.jpg"
}

Listar Publicações

https://

Resposta

[
  {
    "id": "hds773-odsfn987-32nju3-864nj",
    "description": "Hoje istribuimos cestasn básicas no bairro de Vila Mariana",
    "id_institution": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
    "midia": "arquivo.jpg",
  },
];

listar publicação por id

https:

Parâmetros - Corpo da Requisição

{
    "id" : "hds773-odsfn987-32nju3-864nj"
}

Resposta

{
  "id": "hds773-odsfn987-32nju3-864nj",
  "description": "Hoje istribuimos cestasn básicas no bairro de Vila Mariana",
  "id_institution": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
  "midia": "arquivo.jpg"
}

listar publicação por id da instituição

https:

Parâmetros - Corpo da Requisição

{
  "id" : "d1000da0-8921-4b88-9a6d-ccf5c5b473ff"
}

Resposta

{
  "id": "hds773-odsfn987-32nju3-864nj",
  "description": "Hoje istribuimos cestasn básicas no bairro de Vila Mariana",
  "id_institution": "d1000da0-8921-4b88-9a6d-ccf5c5b473ff",
  "midia": "arquivo.jpg"
}

Atualizar Publicação

Parâmetros - Corpo da Requisição

{
  "id": "hds773-odsfn987-32nju3-864nj",
  "description": "Hoje istribuimos cestasn básicas no bairro de Vila Mariana"
}

Resposta

"Publicação atualizada com sucesso";

Atualizar Mídia da Publicação

Parâmetros - Corpo da Requisição

{
  "id": "hds773-odsfn987-32nju3-864nj",
  "midia": "arquivo.jpg"
}

Resposta

"Mídia da publicação atualizada com sucesso";

Excluir Publicação

Parâmetros - Corpo da Requisição

https:

Resposta

"Publicação deletada com sucesso";

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

2 stars

Watchers

3 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages