Info

Welcome to the generated API reference. Get Postman Collection

Avisos


    Array

HTTP Request

GET v2/aviso

Parâmetros

Parâmetro	Tipo	Status	Descrição
token	string	opcional	required Token do visitante (Deve ser passado via Querystring)

Cidade

Lista

    {
     "total": 2,
     "data": [
         {
             "id": 7388,
             "estado_id": 23,
             "nome": "Aceguá"
         },
         {
             "id": 7390,
             "estado_id": 23,
             "nome": "Água Santa"
         }
     ]
 }

HTTP Request

GET v2/cidade

Parâmetros

Parâmetro	Tipo	Status	Descrição
nome	string	opcional	Nome da cidade
sigla	string	opcional	Sigla do estado
estado	inteiro	opcional	Id do estado

Compromisso

Lista

    {
     "total": 2,
     "data": [
         {
             "id": 27,
             "nome": "Fortalecimento da família",
             "descricao": "",
             "imagem": "http://app.gps.rsb.wiidoo.com.br/storage/indicador/familia_circulo.png",
             "cor_predominante": "#c34e5e"
         },
         {
             "id": 28,
             "nome": "Promoção dos Direitos Humanos das crianças, dos adolescentes e dos jovens",
             "descricao": "",
             "imagem": "http://app.gps.rsb.wiidoo.com.br/storage/indicador/promocao_circulo.png",
             "cor_predominante": "#9898ca"
         }
     ]
 }

HTTP Request

GET v2/compromisso

Parâmetros

Parâmetro	Tipo	Status	Descrição
nome	string	opcional	Nome do compromisso

Doacoes

Lista

    {
     "total": 3,
     "data": [
         {
             "id": 251,
             "metodo": "creditCard",
             "status": "CANCELLED_BY_SENDER",
             "status_texto": "Cancelado pelo doador",
             "pedido_cancelamento": 0,
             "assinatura": 1,
             "organizacao_id": 1,
             "organizacao_nome": "Instituto de Ação Social João Paulo II",
             "pagamentos": [
                 {
                     "data_criacao": "10/11/2017",
                     "status": 3,
                     "status_texto": "Paga",
                     "valor": "100,00",
                     "link_boleto": null
                 },
                 {
                     "data_criacao": "10/11/2017",
                     "status": 3,
                     "valor": "100,00",
                     "link_boleto": null
                 },
                 {
                     "data_criacao": "10/11/2017",
                     "status": 7,
                     "valor": "100,00",
                     "link_boleto": null
                 }
             ],
             "plano": {
                 "nome": "Doação Mensal (R$ 100,00)",
                 "descricao": "Descrição - Doação Mensal (R$ 100,00)"
             }
         }
     ] //caso sucesso
     "error": ['token expirado'], //Caso erro - Http Status 401
     "error": ['token inválido'], //Caso erro - Http Status 400
     "error": ['token ausente'], //Caso erro - Http Status 500

HTTP Request

GET v2/doacao

Parâmetros

Parâmetro	Tipo	Status	Descrição
token	string	obrigatório	Token de idenficação do usuário (Deve ser passado via Querystring)

Cancelar

    {
     "sucesso": 0 ou 1 //0 para erro e 1 para sucesso ,
     "error": ['token expirado'], //Caso erro - Http Status 401
     "error": ['token inválido'], //Caso erro - Http Status 400
     "error": ['token ausente'], //Caso erro - Http Status 500

HTTP Request

PUT v2/doacao/cancelar

Parâmetros

Parâmetro	Tipo	Status	Descrição
token	string	obrigatório	Token de idenficação do usuário (Deve ser passado via Querystring)
id	string	obrigatório	ID da doação para cancelar (Somente é possível cancelar doações que são assinaturas)

Cadastro

Para gerar a doação é necessário entrar na webview através desse endereço /doacao/webview?token={token_usuario}&organizacao_id={organizacao_id}

O parâmetro organizacao_id é referente a obra que vai ser realizada a doação, caso seja doação para a conta (parceria cidadã por exemplo) não enviar organizacao_id

HTTP Request

POST v2/doacao/store

Endereço

Detalhe

    {
     {
         "id": 182,
         "estado_id": "24",
         "cidade_id": "13",
         "bairro": "Bairro",
         "logradouro": "logradouro",
         "numero": "221",
         "complemento": "complemento",
         "cep": "99999-999",
         "referencia": "referência",
         "cidade": "Nome da Cidade",
         "estado": "Nome do estado"
     } //caso sucesso
     "error": ['token expirado'], //Caso erro - Http Status 401
     "error": ['token inválido'], //Caso erro - Http Status 400
     "error": ['token ausente'], //Caso erro - Http Status 500

HTTP Request

POST v2/endereco/show

Parâmetros

Parâmetro	Tipo	Status	Descrição
token	string	obrigatório	Token de idenficação do usuário (Deve ser passado via Querystring)

Cadastro

    {
     {
         "id": 182,
         "estado_id": "24",
         "cidade_id": "13",
         "bairro": "Bairro",
         "logradouro": "logradouro",
         "numero": "221",
         "complemento": "complemento",
         "cep": "99999-999",
         "referencia": "referência",
         "cidade": "Nome da Cidade",
         "estado": "Nome do estado"
     } //caso sucesso
     "cep": ["O campo é obrigatório"], //caso erro no campo
     "estado_id": ["O campo é obrigatório"], //caso erro no campo
     //para erros dos outros campos segue o padrão
 }

HTTP Request

POST v2/endereco/store

Parâmetros

Parâmetro	Tipo	Status	Descrição
cep	string	obrigatório	CEP do endereço no formato 99999-999
estado_id	string	obrigatório	Estado do visitante
cidade_id	string	obrigatório	Cidade do visitante
bairro	string	obrigatório	Bairro do visitante (máximo 100 caracteres)
logradouro	string	obrigatório	Logradouro do visitante (máximo 100 caracteres)
numero	string	obrigatório	Número do visitante (máximo 5 digitos)
complemento	string	opcional	Complemento do endereço (máximo 100 caracteres)
referencia	string	opcional	Referência do endereço (máximo 255 caracteres)

Update

    {
     {
         "id": 182,
         "estado_id": "24",
         "cidade_id": "13",
         "bairro": "Bairro",
         "logradouro": "logradouro",
         "numero": "221",
         "complemento": "complemento",
         "cep": "99999-999",
         "referencia": "referência",
         "cidade": "Nome da Cidade",
         "estado": "Nome do estado"
     } //caso sucesso
     "cep": ["O campo é obrigatório"], //caso erro no campo
     "estado_id": ["O campo é obrigatório"], //caso erro no campo
     //para erros dos outros campos segue o padrão
 }

HTTP Request

POST v2/endereco/update

Parâmetros

Parâmetro	Tipo	Status	Descrição
cep	string	obrigatório	CEP do endereço no formato 99999-999
estado_id	string	obrigatório	Estado do visitante
cidade_id	string	obrigatório	Cidade do visitante
bairro	string	obrigatório	Bairro do visitante (máximo 100 caracteres)
logradouro	string	obrigatório	Logradouro do visitante (máximo 100 caracteres)
numero	string	obrigatório	Número do visitante (máximo 5 digitos)
complemento	string	opcional	Complemento do endereço (máximo 100 caracteres)
referencia	string	opcional	Referência do endereço (máximo 255 caracteres)

Estado

Lista

    {
     "total": 2,
     "data": [
         {
             "id": 1,
             "nome": "Acre",
             "sigla": "AC"
         },
         {
             "id": 2,
             "nome": "Alagoas",
             "sigla": "AL"
         }
     ]
 }

HTTP Request

GET v2/estado

Parâmetros

Parâmetro	Tipo	Status	Descrição
nome	string	opcional	Nome do estado
sigla	string	opcional	Sigla do estado

Faixa etária

Lista

    {
     "total": 2,
     "data": [
         {
             "id": 2,
             "nome": "Criança",
             "idade_inicial": 7,
             "idade_final": 11
         },
         {
             "id": 3,
             "nome": "Adolescente",
             "idade_inicial": 12,
             "idade_final": 14
         }
     ]
 }

HTTP Request

GET v2/faixa-etaria

Parâmetros

Parâmetro	Tipo	Status	Descrição
nome	string	opcional	Nome da faixa etária

Favorito

Favoritar

    {
    "favorito" : true //ou false, caso seja removido dos favoritos
}

HTTP Request

POST v2/favorito

Parâmetros

Parâmetro	Tipo	Status	Descrição
token	string	obrigatório	Token de idenficação do usuário (Deve ser passado via Querystring)
organizacao	int	obrigatório	Organização que a ser favoritado

Organização

Lista

    {
     "total": 1, //total geral de registros
     "pagina": 1, //página atual
     "ultima_pagina": 1, //número da última página
     "data": [
         {
             "id": 3,
             "nome": "Organização",
             "tipo_organizacao": "Entidade Social (ONG)",
             "logo": {
                 "P": "http://app.bussola.bruno/storage/organizacao/3/logo/thumb/16c282916bec1717ec2c76b9d07c2aab.png",
                 "M": "http://app.bussola.bruno/storage/organizacao/3/logo/media/16c282916bec1717ec2c76b9d07c2aab.png",
                 "O": "http://app.bussola.bruno/storage/organizacao/3/logo/16c282916bec1717ec2c76b9d07c2aab.png"
             },
             "tipo_pessoa": "PJ",
             "cpf": null,
             "cnpj": "11.111.111/1111-11",
             "razao_social": "Organização - LTDA",
             "data_fundacao": "20/01/2000",
             "sobre": "O Grupo Organização surgiu em 12 de setembro de 2000 através da visão do empreendedor de seu Fundados Tem como missão valorizar espaços, proporcionando bem-estar, elegância, conforto e exclusividade.\n\nO sucesso desse estilo único da organização de morar está baseado nos investimentos em padrão de qualidade superior, em trazer de forma sofisticada constantes novidades mundiais aos projetos e, é claro, na atenção extrema aos detalhes: desde a concepção, os acabamentos até a exploração na arquitetura e decoração dos ambientes. Tudo isso, em lugares muito charmosos, seletos e estratégicos para um privilégio que é todo seu.",
             "site": "www.organizacao.com.br",
             "skype": "org.skype",
             "custo_mensal": "150.00",
             "publico_atendido": "45",
             "endereco": {
                 "estado": "Santa Catarina",
                 "sigla": "SC",
                 "cidade": "Itajaí",
                 "bairro": "Centro",
                 "logradouro": "Ana Costa",
                 "numero": 359,
                 "complemento": null,
                 "cep": "89520-000",
                 "referencia": "Em frente a AABB",
                 "latitude": "-27.2840413",
                 "longitude": "-50.5851364"
             },
             "telefones": [
                 "(11) 1111-11111",
                 "(22) 2222-22222",
                 "(33) 3333-33333"
             ],
             "emails": [
                 "principal@organizacao.com.br",
                 "secundario@organizacao.com.br"
             ],
             "redes_sociais": {
                 "facebook": "https://www.facebook.com/organizacao/",
                 "twitter": "https://www.twitter.com/organizacao/",
                 "instagram": "https://www.instagram.com/organizacao/",
                 "linkedin": "https://www.linkedin.com/organizacao/",
                 "youtube": "www.youtube.com/organizacao"
             },
             "areas_atuacoes": [
                 "Ação Complementar à Escola",
                 "Atenção à Família",
                 "Medidas Socioeducativas",
                 "Práticas Esportivas",
                 "Proteção à Infância"
             ]
         }
     ]
}

HTTP Request

GET v2/organizacao

Parâmetros

Parâmetro	Tipo	Status	Descrição
logo	inteiro	opcional	Possui logo ou não, valores 1 ou 0
nome	string	opcional	Nome da organização
estado_id	inteiro\|array	opcional	Estado da organização
cidade_id	inteiro\|array	opcional	Cidade da organização
area_atuacao_id	inteiro\|array	opcional	Area de atuação da organização
limite	inteiro	opcional	Determina a quantidade de registros, caso não determinado irá ser limitado em 20 registros
pagina	inteiro	opcional	Determina a página atual dos registros

Detalhe

    {
     "total": 1, //total geral de registros
     "pagina": 1, //página atual
     "ultima_pagina": 1, //número da última página
     "data": [
         {
             "id": 3,
             "nome": "Organização",
             "tipo_organizacao": "Entidade Social (ONG)",
             "logo": {
                 "P": "http://app.bussola.bruno/storage/organizacao/3/logo/thumb/16c282916bec1717ec2c76b9d07c2aab.png",
                 "M": "http://app.bussola.bruno/storage/organizacao/3/logo/media/16c282916bec1717ec2c76b9d07c2aab.png",
                 "O": "http://app.bussola.bruno/storage/organizacao/3/logo/16c282916bec1717ec2c76b9d07c2aab.png"
             },
             "tipo_pessoa": "PJ",
             "cpf": null,
             "cnpj": "11.111.111/1111-11",
             "razao_social": "Organização - LTDA",
             "data_fundacao": "20/01/2000",
             "sobre": "O Grupo Organização surgiu em 12 de setembro de 2000 através da visão do empreendedor de seu Fundados Tem como missão valorizar espaços, proporcionando bem-estar, elegância, conforto e exclusividade.\n\nO sucesso desse estilo único da organização de morar está baseado nos investimentos em padrão de qualidade superior, em trazer de forma sofisticada constantes novidades mundiais aos projetos e, é claro, na atenção extrema aos detalhes: desde a concepção, os acabamentos até a exploração na arquitetura e decoração dos ambientes. Tudo isso, em lugares muito charmosos, seletos e estratégicos para um privilégio que é todo seu.",
             "site": "www.organizacao.com.br",
             "skype": "org.skype",
             "endereco": {
                 "estado": "Santa Catarina",
                 "sigla": "SC",
                 "cidade": "Itajaí",
                 "bairro": "Centro",
                 "logradouro": "Ana Costa",
                 "numero": 359,
                 "complemento": null,
                 "cep": "89520-000",
                 "referencia": "Em frente a AABB",
                 "latitude": "-27.2840413",
                 "longitude": "-50.5851364"
             },
             "telefones": [
                 "(11) 1111-11111",
                 "(22) 2222-22222",
                 "(33) 3333-33333"
             ],
             "emails": [
                 "principal@organizacao.com.br",
                 "secundario@organizacao.com.br"
             ],
             "redes_sociais": {
                 "facebook": "https://www.facebook.com/organizacao/",
                 "twitter": "https://www.twitter.com/organizacao/",
                 "instagram": "https://www.instagram.com/organizacao/",
                 "linkedin": "https://www.linkedin.com/organizacao/",
                 "youtube": "www.youtube.com/organizacao"
             },
             "areas_atuacoes": [
                 "Ação Complementar à Escola",
                 "Atenção à Família",
                 "Medidas Socioeducativas",
                 "Práticas Esportivas",
                 "Proteção à Infância"
             ]
         }
     ]
}

HTTP Request

GET v2/organizacao/{organizacao}

Parâmetros

Parâmetro	Tipo	Status	Descrição
organizacao	inteiro	opcional	ID da organização

Paginas

Lista

    {
     "nome": "Ação social",
     "conteudo": "<p class=\"ql-align-justify\">Você, ou sua empresa, se tornando parceiros da Rede Salesiana Brasil de Ação Social (RSB-Social) na promoção de crianças, de adolescentes e de jovens em situação de maior vulnerabilidade. A RSB-Social articula a ação em Rede das Obras Sociais Salesianas, assegurando qualidade e transparência nos atendimentos oferecidos em todas as suas presenças e diferentes projetos.</p><p><br></p><p class=\"ql-align-justify\">Ao <strong>colaborar</strong> com a <strong>UPV</strong> você pode fazê-lo escolhendo um projeto específico ou a PARCERIA CIDADÃ. Ao escolher a <strong>Parceria Cidadã</strong> seu recurso será destinado para o Escritório Central da Rede Salesiana de Ação Social responsável pela animação das mais de 120 Obras Salesianas e dezenas de projetos sociais em todo o Brasil. Esse recurso será destinado para aquelas obras que necessitem de uma atenção especial ou que executam projetos com desafios maiores e em regiões mais carentes. <em>O destino final do seu investimento será sempre a criança e o adolescente atendidos em nossos projetos sociais</em>.</p><p class=\"ql-align-center\"><br></p>",
     "chave": "UPV.ACAOSOCIAL",
 }

HTTP Request

GET v2/pagina/{pagina}

Parâmetros

Parâmetro	Tipo	Status	Descrição
chave	string	opcional	required chave referente a página desejada ( UPV.ACAOSOCIAL	UPV.SOBRE	UPV.COMPROMISSOS	UPV.COMPROMISSOS.PROMOCAO	UPV.COMPROMISSOS.GESTAO	UPV.COMPROMISSOS.FORTALECIMENTO	UPV.COMPROMISSOS.ACAO	UPV.COMPROMISSOS.CONSTRUCAO	UPV.COMPROMISSOS.COOPERACAO	UPV.POLITICA-PRIVACIDADE	UPV.HOME	UPV.TERMOS	UPV.SUPORTE	CADASTRO.EXTERNO	UPV.HOME.PARCERIA	UPV.HOME.BANNERAPP	UPV.HOME.RESPONSAVEIS	UPV.PROJETOS.PARCERIA)

Parceria cidadã

Pagina

    {
     "nome": "Parceria Cidadã",
     "conteudo": "<p class=\"ql-align-justify\">Você, ou sua empresa, se tornando parceiros da Rede Salesiana Brasil de Ação Social (RSB-Social) na promoção de crianças, de adolescentes e de jovens em situação de maior vulnerabilidade. A RSB-Social articula a ação em Rede das Obras Sociais Salesianas, assegurando qualidade e transparência nos atendimentos oferecidos em todas as suas presenças e diferentes projetos.</p><p><br></p><p class=\"ql-align-justify\">Ao <strong>colaborar</strong> com a <strong>UPV</strong> você pode fazê-lo escolhendo um projeto específico ou a PARCERIA CIDADÃ. Ao escolher a <strong>Parceria Cidadã</strong> seu recurso será destinado para o Escritório Central da Rede Salesiana de Ação Social responsável pela animação das mais de 120 Obras Salesianas e dezenas de projetos sociais em todo o Brasil. Esse recurso será destinado para aquelas obras que necessitem de uma atenção especial ou que executam projetos com desafios maiores e em regiões mais carentes. <em>O destino final do seu investimento será sempre a criança e o adolescente atendidos em nossos projetos sociais</em>.</p><p class=\"ql-align-center\"><br></p>",
     "educandos": 18000,
     "educadores": 5000,
     "numeroObras": 105,
     "doadores": 37,
 }

HTTP Request

GET v2/parceria-cidada

Planos

Lista

    {
     "total": 2,
     "data": [
         {
             "id": 1,
             "nome": "Doação Única",
             "descricao": "",
             "assinatura": 0
         },
         {
             "id": 2,
             "nome": "Doação Mensal (R$ 100,00)",
             "descricao": "Descrição - Doação Mensal (R$ 100,00)",
             "assinatura": 1
         }
     ]
 }

HTTP Request

GET v2/plano

Parâmetros

Parâmetro	Tipo	Status	Descrição
projeto	inteiro	opcional	Projeto que terá os planos buscados
organizacao	inteiro	opcional	Obra que terá os planos buscados

Programa

Lista

    {
     "total": 2,
     "data": [
         {
             "id": 32,
             "nome": "Abuso e exploração sexual",
             "descricao": null
         },
         {
             "id": 21,
             "nome": "Academia de artes cênicas",
             "descricao": null
         }
     ]
 }

HTTP Request

GET v2/programa

Parâmetros

Parâmetro	Tipo	Status	Descrição
nome	string	opcional	Nome do programa

Projeto

Lista

    {
     "total": 1, //total geral de registros
     "pagina": 1, //página atual
     "ultima_pagina": 1, //número da última página
     "data": [
         {
             "id": 136,
             "nome": "APOIO PEDAGÓGICO MARLÚCIA C MATUTINO",
             "organizacao_id": 123,
             "organizacao": {
                 "nome": "Centro Juvenil Padre Giovanni Pini",
                 "endereco": "RUA 66. INDEPENDÊNCIA MANSÕES, Qd 125 Lt 16, Aparecida de Goiânia / GO",
                 "responsavel": {
                     "nome": "Responsável pela organização",
                     "telefone": [
                         "(47) 9915-54784",
                         "(11) 4455-21488"
                     ],
                     "email": [
                         "coordenador1@gmail.com",
                         "coordenador2@gmail.com"
                     ]
                 }
             },
             "objetivo_geral": "Objetivo geral",
             "custo_por_atendido": "60,00",
             "publico": [
                 {
                     "quantidade": 2,
                     "masculino": 1,
                     "feminino": 1,
                     "crianca": 0,
                     "adolescente": 0,
                     "jovens": 1,
                     "adultos": 1,
                     "idosos": 0
                 }
             ],
             "logo": {
                 "P": "http://app.gps.rsb.wiidoo.com.br/storage/organizacao/87/projeto/182/logo/thumb/dea0bffc2c4af2c5ffded3dec1f42cc7.jpg",
                 "M": "http://app.gps.rsb.wiidoo.com.br/storage/organizacao/87/projeto/182/logo/media/dea0bffc2c4af2c5ffded3dec1f42cc7.jpg",
                 "O": "http://app.gps.rsb.wiidoo.com.br/storage/organizacao/87/projeto/182/logo/dea0bffc2c4af2c5ffded3dec1f42cc7.jpg"
             },
             "imagem": [
                 {
                     "P": "https://upv.org.br/storage/atendimento/atividade/877/12/thumb/3b08f2e00ef9b63b39868d8b483f5d07.png",
                     "M": "https://upv.org.br/storage/atendimento/atividade/877/12/media/3b08f2e00ef9b63b39868d8b483f5d07.png",
                     "G": "https://upv.org.br/storage/atendimento/atividade/877/12/big/3b08f2e00ef9b63b39868d8b483f5d07.png",
                     "I": "https://upv.org.br/storage/atendimento/atividade/877/12/impressao/3b08f2e00ef9b63b39868d8b483f5d07.png"
                 },
                 {
                     "P": "https://upv.org.br/storage/atendimento/atividade/877/12/thumb/efa717ba3cf025fea52a3168a66c25eb.png",
                     "M": "https://upv.org.br/storage/atendimento/atividade/877/12/media/efa717ba3cf025fea52a3168a66c25eb.png",
                     "G": "https://upv.org.br/storage/atendimento/atividade/877/12/big/efa717ba3cf025fea52a3168a66c25eb.png",
                     "I": "https://upv.org.br/storage/atendimento/atividade/877/12/impressao/efa717ba3cf025fea52a3168a66c25eb.png"
                 }
             ],
             "indicadores": [
             {
                 "id": 28,
                 "nome": "Promoção dos Direitos Humanos das crianças, dos adolescentes e dos jovens"
             },
             {
                 "id": 30,
                 "nome": "Cooperação para o desenvolvimento com enfoque social"
             }
         }
     ]
 }

HTTP Request

GET v2/projeto

Parâmetros

Parâmetro	Tipo	Status	Descrição
logo	inteiro	opcional	Possui logo ou não, valores 1 ou 0
nome	string	opcional	Nome do projeto
estado_id	inteiro\|array	opcional	Estado da organização vinculada ao projeto
cidade_id	inteiro\|array	opcional	Cidade da organização vinculada ao projeto
organizacao_id	inteiro\|array	opcional	Organização do projeto
programaId	inteiro\|array	opcional	Programa do projeto
faixa_etaria_id	inteiro\|array	opcional	Faixa etária que o projeto atende
area_atuacao_id	inteiro\|array	opcional	Area de atuação do projeto
limite	inteiro	opcional	Determina a quantidade de registros, caso não determinado irá ser limitado em 20 registros
pagina	inteiro	opcional	Determina a página atual dos registros
destaque	boolean	opcional	Quando true define que os projetos retornados devem ser os projetos em destaque
populares	boolean	opcional	Quando true define que os projetos retornados devem vir em ordem de popularidade
novos	boolean	opcional	Quando true define que os projetos retornados devem vir em ordem de cadastro - mais recente
favoritos	boolean	opcional	Quando true define que os projetos retornados devem ser os projetos favoritos do visitante logado - ( quando true deve ser passado o parametro $token do visitante que conectado via querystring)
compromisso_fundamental	inteiro	opcional	Compromisso do projeto

Detalhe

    {
     "total": 1, //total geral de registros
     "pagina": 1, //página atual
     "ultima_pagina": 1, //número da última página
     "data": [
         {
             "id": 136,
             "nome": "APOIO PEDAGÓGICO MARLÚCIA C MATUTINO",
             "organizacao_id": 123,
             "organizacao": {
                 "nome": "Centro Juvenil Padre Giovanni Pini",
                 "endereco": "RUA 66. INDEPENDÊNCIA MANSÕES, Qd 125 Lt 16, Aparecida de Goiânia / GO",
                 "responsavel": {
                     "nome": "Responsável pela organização",
                     "telefone": [
                         "(47) 9915-54784",
                         "(11) 4455-21488"
                     ],
                     "email": [
                         "coordenador1@gmail.com",
                         "coordenador2@gmail.com"
                     ]
                 }
             },
             "objetivo_geral": "Objetivo geral",
             "custo_por_atendido": "60,00",
             "publico": [
                 {
                     "quantidade": 2,
                     "masculino": 1,
                     "feminino": 1,
                     "crianca": 0,
                     "adolescente": 0,
                     "jovens": 1,
                     "adultos": 1,
                     "idosos": 0
                 }
             ],
             "logo":
              {
                  "P": "https://upv.org.br/storage/atendimento/atividade/877/12/thumb/3b08f2e00ef9b63b39868d8b483f5d07.png",
                  "M": "https://upv.org.br/storage/atendimento/atividade/877/12/media/3b08f2e00ef9b63b39868d8b483f5d07.png",
                  "O": "https://upv.org.br/storage/atendimento/atividade/877/12/big/3b08f2e00ef9b63b39868d8b483f5d07.png",
              },
             "imagem": [
                 {
                     "P": "https://upv.org.br/storage/atendimento/atividade/877/12/thumb/3b08f2e00ef9b63b39868d8b483f5d07.png",
                     "M": "https://upv.org.br/storage/atendimento/atividade/877/12/media/3b08f2e00ef9b63b39868d8b483f5d07.png",
                     "G": "https://upv.org.br/storage/atendimento/atividade/877/12/big/3b08f2e00ef9b63b39868d8b483f5d07.png",
                     "I": "https://upv.org.br/storage/atendimento/atividade/877/12/impressao/3b08f2e00ef9b63b39868d8b483f5d07.png"
                 },
                 {
                     "P": "https://upv.org.br/storage/atendimento/atividade/877/12/thumb/efa717ba3cf025fea52a3168a66c25eb.png",
                     "M": "https://upv.org.br/storage/atendimento/atividade/877/12/media/efa717ba3cf025fea52a3168a66c25eb.png",
                     "G": "https://upv.org.br/storage/atendimento/atividade/877/12/big/efa717ba3cf025fea52a3168a66c25eb.png",
                     "I": "https://upv.org.br/storage/atendimento/atividade/877/12/impressao/efa717ba3cf025fea52a3168a66c25eb.png"
                 }
             ],
             "indicadores": [
             {
                 "id": 28,
                 "nome": "Promoção dos Direitos Humanos das crianças, dos adolescentes e dos jovens"
             },
             {
                 "id": 30,
                 "nome": "Cooperação para o desenvolvimento com enfoque social"
             }
         }
     ]
 }

HTTP Request

GET v2/projeto/{projeto}

Parâmetros

Parâmetro	Tipo	Status	Descrição
projeto	inteiro	opcional	ID do projeto

Usuário

Cadastro

    {
     "token": hash de identificação do usuário, //caso sucesso
     "nome": ["O campo é obrigatório"], //caso erro no campo
     "email": ["O campo é obrigatório"], //caso erro no campo
     //para erros dos outros campos segue o padrão
 }

HTTP Request

POST v2/visitante

Parâmetros

Parâmetro	Tipo	Status	Descrição
nome	string	obrigatório	Nome/Razão social do usuário (máximo 255 caracteres)
foto	file	opcional	Foto do atendido.
email	string	obrigatório	Email do usuário (email válido, email único, máximo 100 caracteres)
senha	string	obrigatório	Senha do usuário (mínimo 6 caracteres, máximo 100 caracteres)
senha_confirmation	string	obrigatório	Validar senha do usuário (mínimo 6 caracteres, máximo 100 caracteres)
tipo	string	obrigatório	Tipo do usuário (valores possíveis: 'PF' para pessoa física ou 'PJ' para pessoa jurídica,
cpf	string\|númerico	opcional	CPF do usuário (obrigatório se $tipo = 'PF', CPF válido, CPF único)
cnpj	string\|númerico	opcional	CNPJ do usuário (obrigatório se $tipo = 'PJ', CNPJ válido, CNPJ único)
sexo	string	opcional	Sexo do usuário (valores possíveis: 'M' para masculino, 'F' para feminino)
contato	string	opcional	Contato do usuário (utilizado somente de $tipo = 'PJ')
telefone	string	opcional	Telefone do usuário no formato (99) 99999-9999
data_nascimento	string	opcional	Data de nascimento do usuário (utilizado somente se $tipo = 'PF')

Detalhe

    {
      {
         "nome": "Wiidoo Tecnologia",
         "email": "wiidoo@wiidoo.com.br",
         "tipo": "'PF' ou 'PJ'",
         "cpf": "000.000.000-00", //somente se $tipo = 'PF'
         "cnpj": "00.000.000/0000-00", //soente se $tipo = 'PJ'
         "endereco": "Rua Doutor Nereu Ramos, 197 - Sala 201 - 88301-215 - Centro - Itajaí/SC",
         "sexo": "'M' ou 'F'", //somente se $tipo = 'PF'
         "contato": "Vinicius Schlup", //somente se $tipo = 'PJ'
         "telefone": "(99) 99999-9999",
         "data_nascimento": "01/01/2000", //somente se $tipo = 'PF'
     } //caso sucesso
     "error": ['token expirado'], //Caso erro - Http Status 401
     "error": ['token inválido'], //Caso erro - Http Status 400
     "error": ['token ausente'], //Caso erro - Http Status 500

HTTP Request

GET v2/visitante/show

Parâmetros

Parâmetro	Tipo	Status	Descrição
token	string	opcional		required Token de idenficação do usuário (Deve ser passado via Querystring)

Alteração

    {
     {
         "nome": "Wiidoo Tecnologia",
         "email": "wiidoo@wiidoo.com.br",
         "tipo": "'PF' ou 'PJ'",
         "cpf": "000.000.000-00", //somente se $tipo = 'PF'
         "cnpj": "00.000.000/0000-00", //soente se $tipo = 'PJ'
         "endereco": "Rua Doutor Nereu Ramos, 197 - Sala 201 - 88301-215 - Centro - Itajaí/SC",
         "sexo": "'M' ou 'F'", //somente se $tipo = 'PF'
         "contato": "Vinicius Schlup", //somente se $tipo = 'PJ'
         "telefone": "(99) 99999-9999",
         "data_nascimento": "01/01/2000", //somente se $tipo = 'PF'
     } //caso sucesso
     "error": ['token expirado'], //Caso erro - Http Status 401
     "error": ['token inválido'], //Caso erro - Http Status 400
     "error": ['token ausente'], //Caso erro - Http Status 500
}

HTTP Request

PUT v2/visitante/update

Parâmetros

Parâmetro	Tipo	Status	Descrição
token	string	opcional		required Token de idenficação do usuário (Deve ser passado via Querystring)
senha	string	opcional	Senha do usuário (mínimo 6 caracteres, máximo 100 caracteres)
senha_confirmation	string	opcional	Validação da senha do usuário (mínimo 6 caracteres, máximo 100 caracteres)(obrigatório quando a senha é passada)
foto_excluida	bool	opcional	caso seja passado, exclui a foto do usuário

Autenticar

    {
     "token": hash de identificação do usuário, //caso sucesso na autenticação,
     "expiration": timestamp quando o token expira //caso sucesso na autenticação
     "email": ["O campo é obrigatório"], //caso não envie o email
     "senha": ["O campo é obrigatório"], //caso não envie a senha,
     "error": ["Credencial inválida"], //caso não encontre o usuário - Http Status 401
 }

HTTP Request

POST v2/auth/login

Parâmetros

Parâmetro	Tipo	Status	Descrição
email	string	opcional	Email do usuário (obrigatório)
senha	string	opcional	Senha do usuário (obrigatório)

Autenticar via rede social

    {
     "token": hash de identificação do usuário, //caso sucesso na autenticação,
     "expiration": timestamp quando o token expira //caso sucesso na autenticação
     "email": ["O campo é obrigatório"], //caso não envie o email
     "senha": ["O campo é obrigatório"], //caso não envie a senha,
     "error": ["Credencial inválida"], //caso não encontre o usuário - Http Status 401
 }

HTTP Request

POST v2/auth/login-social

Parâmetros

Parâmetro	Tipo	Status	Descrição
provider_id	string	opcional	ID disponibilizado pelo (obrigatório)
provider	string	opcional	Nome da rede social(facebook/google) (obrigatório)

Refresh token

    {
      token": hash de identificação do usuário, //caso sucesso na atualização do token,
     "expiration": timestamp quando o token expira //caso sucesso na atualização do token
     "error": ['token expirado'], //Caso erro - Http Status 401
     "error": ['token inválido'], //Caso erro - Http Status 400
     "error": ['token ausente'], //Caso erro - Http Status 500

HTTP Request

POST v2/auth/refresh-token

Parâmetros

Parâmetro	Tipo	Status	Descrição
token	string	obrigatório	Token de idenficação do usuário (Deve ser passado via Querystring)

Área de atuação

Lista

    {
     "total": 2,
     "data": [
         {
             "id": 1,
             "nome": "Ação Complementar à Escola"
         },
         {
             "id": 2,
             "nome": "Acolhimento Institucional"
         }
     ]
 }

HTTP Request

GET v2/area-atuacao

Parâmetros

Parâmetro	Tipo	Status	Descrição
nome	string	opcional	Nome da área de atuação