API Condomínio Interativo

Documetação da nova API do Condomínio Interativo.

Se der algum erro de banco de dados, execute:

sh refresh.sh

Access Requests 1

Solicitações de acesso ao condomínio. Exemplo: um novo usuário que deseja se vincular ao seu condomínio e unidade.

Description

Cria uma requisição de acesso ao condomínio.

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjUwM2JiZGIyNDgwZTQ3NWU2N2EzNTY0YjhmODc2NmE3NDk2YmQxMjNiNDk4NTFmNjkyYTFmYTkyMmYxNDI3YTY1Y2NjOGE4YzBmYjUxNDM2In0.eyJhdWQiOiIxIiwianRpIjoiNTAzYmJkYjI0ODBlNDc1ZTY3YTM1NjRiOGY4NzY2YTc0OTZiZDEyM2I0OTg1MWY2OTJhMWZhOTIyZjE0MjdhNjVjY2M4YThjMGZiNTE0MzYiLCJpYXQiOjE1NzY1MTYwMDQsIm5iZiI6MTU3NjUxNjAwNCwiZXhwIjoxNjA4MTM4NDA0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.HlK1xJqgxQav07MjSQnhD2W1GH0YfJjbezgA7T6d_L9Zk3UXCroVrfsktQXtygcU_FBTDp8WuuH1IoUT5dvt6FwSsIJlJcvhlJ5zA0nbqdfbL2XAatf1VL7pbryZUT_g6j6ivbcAdgRFEuB7eONlP_PIAynutClchX1z6nTfT-RqR68qdpxdqtiubEPiQ6EpY7MMMC0wcFlYC-mxHYca6XaeUqO6L0_bt_QQ4H5ZjYBipyLZE0geYnfZP10ABi9ukWgqRQHE1Re0Lz35WQTZ4tQOupdL6e-WSxPckHLrIZ4b_mzI2T-r6OusixFUSDVuCNmN0RnvvgGTVJt6TXgd81a6rCCQ6wzl-GXI22WwJKyO0O614gEtSTBE4bK0pg3cPcYOSMUhmEEngi2GgF_l5l32tKPtoX_SeTB2u0kx9pC51unRrXBukZfPIzEDA39w4Y7j810qPOi_Wmy-SQxuPtybjQJlpraFYRjQk0ms6ls882_eQqrEINHskiHQhp4kdSkuacFweBj9RCQhldgSIbBCAX-IjXctwWZ5hLwm2Gs6ZZm4_EE7oJPhrhflKr56Gx5Sj6hZBdUbhwTQ4dcIc-kkW3w5Oe3IuK5PBvF9SOdB2YaWZ9ZaI5FODred0_X6qssgFNcdqvTSlLn3DS_In9jg9DsKDDXH3IZcbloOWKg
Body
KeyValueDescription
user_id1
condominio_id1379
unity102
Response
Succes | Code: 200
{ "success": "Solicitação feita com sucesso!", "access_request": { "user_id": "1", "condominio_id": "1379", "unity": "102", "id": 2 } }

Cidade e Estado 2

Description

Lista todos os estados

Response
Estados - Sucesso | Code: 200
[ { "id": 1, "nome": "Acre", "sigla": "AC" }, { "id": 2, "nome": "Alagoas", "sigla": "AL" }, { "id": 3, "nome": "Amazonas", "sigla": "AM" }, { "id": 4, "nome": "Amapá", "sigla": "AP" }, { "id": 5, "nome": "Bahia", "sigla": "BA" }, { "id": 6, "nome": "Ceará", "sigla": "CE" }, { "id": 7, "nome": "Distrito Federal", "sigla": "DF" }, { "id": 8, "nome": "Espirito Santo", "sigla": "ES" }, { "id": 9, "nome": "Goiás", "sigla": "GO" }, { "id": 10, "nome": "Maranhão", "sigla": "MA" }, { "id": 11, "nome": "Minas Gerais", "sigla": "MG" }, { "id": 12, "nome": "Mato Grosso do Sul", "sigla": "MS" }, { "id": 13, "nome": "Mato Grosso", "sigla": "MT" }, { "id": 14, "nome": "Pará", "sigla": "PA" }, { "id": 15, "nome": "Paraíba", "sigla": "PB" }, { "id": 16, "nome": "Pernambuco", "sigla": "PE" }, { "id": 17, "nome": "Piauí", "sigla": "PI" }, { "id": 18, "nome": "Paraná", "sigla": "PR" }, { "id": 19, "nome": "Rio de Janeiro", "sigla": "RJ" }, { "id": 20, "nome": "Rio Grande do Norte", "sigla": "RN" }, { "id": 21, "nome": "Rondônia", "sigla": "RO" }, { "id": 22, "nome": "Roraima", "sigla": "RR" }, { "id": 23, "nome": "Rio Grande do Sul", "sigla": "RS" }, { "id": 24, "nome": "Santa Catarina", "sigla": "SC" }, { "id": 25, "nome": "Sergipe", "sigla": "SE" }, { "id": 26, "nome": "São Paulo", "sigla": "SP" }, { "id": 27, "nome": "Tocantins", "sigla": "TO" } ]
Description

Lista cidades de acordo com o estado.

Response
Cidades | Code: 200
[ { "id": 3, "nome": "Brasiléia", "codigo_ibge": 120010, "estado_id": 1, "populacao_2010": 21398, "densidade_demo": "5.46", "gentilico": "brasileense", "area": "3916.507" }, { "id": 5, "nome": "Capixaba", "codigo_ibge": 120017, "estado_id": 1, "populacao_2010": 8798, "densidade_demo": "5.17", "gentilico": "capixabense", "area": "1702.581" }, { "id": 7, "nome": "Epitaciolândia", "codigo_ibge": 120025, "estado_id": 1, "populacao_2010": 15100, "densidade_demo": "9.13", "gentilico": "epitaciolandense", "area": "1654.773" }, { "id": 8, "nome": "Feijó", "codigo_ibge": 120030, "estado_id": 1, "populacao_2010": 32412, "densidade_demo": "1.16", "gentilico": "feijoense", "area": "27974.551" }, { "id": 10, "nome": "Mâncio Lima", "codigo_ibge": 120033, "estado_id": 1, "populacao_2010": 15206, "densidade_demo": "2.79", "gentilico": "mancio-limense", "area": "5453.042" }, { "id": 12, "nome": "Marechal Thaumaturgo", "codigo_ibge": 120035, "estado_id": 1, "populacao_2010": 14227, "densidade_demo": "1.74", "gentilico": "thaumaturguense", "area": "8191.728" }, { "id": 14, "nome": "Porto Acre", "codigo_ibge": 120080, "estado_id": 1, "populacao_2010": 14880, "densidade_demo": "5.71", "gentilico": "portoacrense", "area": "2604.725" }, { "id": 15, "nome": "Porto Walter", "codigo_ibge": 120039, "estado_id": 1, "populacao_2010": 9176, "densidade_demo": "1.42", "gentilico": "portowaltense", "area": "6443.851" }, { "id": 17, "nome": "Rodrigues Alves", "codigo_ibge": 120042, "estado_id": 1, "populacao_2010": 14389, "densidade_demo": "4.68", "gentilico": "rodriguesalvense", "area": "3076.99" }, { "id": 19, "nome": "Sena Madureira", "codigo_ibge": 120050, "estado_id": 1, "populacao_2010": 38029, "densidade_demo": "1.6", "gentilico": "sena-madureirense", "area": "23751.268" }, { "id": 21, "nome": "Tarauacá", "codigo_ibge": 120060, "estado_id": 1, "populacao_2010": 35590, "densidade_demo": "1.76", "gentilico": "tarauacaense", "area": "20171.019" }, { "id": 22, "nome": "Xapuri", "codigo_ibge": 120070, "estado_id": 1, "populacao_2010": 16091, "densidade_demo": "3.01", "gentilico": "xapuriense", "area": "5347.283" }, { "id": 1, "nome": "Acrelândia", "codigo_ibge": 120001, "estado_id": 1, "populacao_2010": 12538, "densidade_demo": "6.94", "gentilico": "acrelandense", "area": "1807.891" }, { "id": 2, "nome": "Assis Brasil", "codigo_ibge": 120005, "estado_id": 1, "populacao_2010": 6072, "densidade_demo": "1.22", "gentilico": "assis-brasiliense", "area": "4974.193" }, { "id": 4, "nome": "Bujari", "codigo_ibge": 120013, "estado_id": 1, "populacao_2010": 8471, "densidade_demo": "2.79", "gentilico": "bujariense", "area": "3034.849" }, { "id": 6, "nome": "Cruzeiro Do Sul", "codigo_ibge": 120020, "estado_id": 1, "populacao_2010": 78507, "densidade_demo": "8.94", "gentilico": "cruzeirense", "area": "8779.19" }, { "id": 9, "nome": "Jordão", "codigo_ibge": 120032, "estado_id": 1, "populacao_2010": 6577, "densidade_demo": "1.23", "gentilico": "jordãoense", "area": "5357.299" }, { "id": 11, "nome": "Manoel Urbano", "codigo_ibge": 120034, "estado_id": 1, "populacao_2010": 7981, "densidade_demo": "0.75", "gentilico": "manoel-urbanense", "area": "10634.539" }, { "id": 13, "nome": "Plácido De Castro", "codigo_ibge": 120038, "estado_id": 1, "populacao_2010": 17209, "densidade_demo": "8.86", "gentilico": "placidiano", "area": "1943.249" }, { "id": 16, "nome": "Rio Branco", "codigo_ibge": 120040, "estado_id": 1, "populacao_2010": 336038, "densidade_demo": "38.03", "gentilico": "rio-branquense", "area": "8835.675" }, { "id": 18, "nome": "Santa Rosa Do Purus", "codigo_ibge": 120043, "estado_id": 1, "populacao_2010": 4691, "densidade_demo": "0.76", "gentilico": "santarosense", "area": "6145.625" }, { "id": 20, "nome": "Senador Guiomard", "codigo_ibge": 120045, "estado_id": 1, "populacao_2010": 20179, "densidade_demo": "8.69", "gentilico": "guiomaense", "area": "2321.452" } ]

Condomino 4

Condômino

Description

Adição de condôminos ao condomínio

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Body
KeyValueDescription
id_condominio2244
apartamento1022
blocoA
emailcoisa@techmetria.com
Response
Create Condomino | Code: 200
{ "error": "Unidade já cadastrada!" }
Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Body
KeyValueDescription
excel

Arquivo excel para importação

Response
Import upload | Code: 200
[ { "linha": 2, "resposta": "já cadastrado", "id_condomino": 66107 } ]
Description

Verifica se o token de condomino é válido

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Response
Success | Code: 200
{ "success": "O token é válido" }
Description

Download do arquivo de exemplo para importação de condominos. Não é feita pra chamar via XHR. Quando o usuário clicar, abrir em outra aba pr download.

Condomínio 6

Rotas para consumir dados de condomínios.

Description

Pega um campo específico embaralhado.

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjUwM2JiZGIyNDgwZTQ3NWU2N2EzNTY0YjhmODc2NmE3NDk2YmQxMjNiNDk4NTFmNjkyYTFmYTkyMmYxNDI3YTY1Y2NjOGE4YzBmYjUxNDM2In0.eyJhdWQiOiIxIiwianRpIjoiNTAzYmJkYjI0ODBlNDc1ZTY3YTM1NjRiOGY4NzY2YTc0OTZiZDEyM2I0OTg1MWY2OTJhMWZhOTIyZjE0MjdhNjVjY2M4YThjMGZiNTE0MzYiLCJpYXQiOjE1NzY1MTYwMDQsIm5iZiI6MTU3NjUxNjAwNCwiZXhwIjoxNjA4MTM4NDA0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.HlK1xJqgxQav07MjSQnhD2W1GH0YfJjbezgA7T6d_L9Zk3UXCroVrfsktQXtygcU_FBTDp8WuuH1IoUT5dvt6FwSsIJlJcvhlJ5zA0nbqdfbL2XAatf1VL7pbryZUT_g6j6ivbcAdgRFEuB7eONlP_PIAynutClchX1z6nTfT-RqR68qdpxdqtiubEPiQ6EpY7MMMC0wcFlYC-mxHYca6XaeUqO6L0_bt_QQ4H5ZjYBipyLZE0geYnfZP10ABi9ukWgqRQHE1Re0Lz35WQTZ4tQOupdL6e-WSxPckHLrIZ4b_mzI2T-r6OusixFUSDVuCNmN0RnvvgGTVJt6TXgd81a6rCCQ6wzl-GXI22WwJKyO0O614gEtSTBE4bK0pg3cPcYOSMUhmEEngi2GgF_l5l32tKPtoX_SeTB2u0kx9pC51unRrXBukZfPIzEDA39w4Y7j810qPOi_Wmy-SQxuPtybjQJlpraFYRjQk0ms6ls882_eQqrEINHskiHQhp4kdSkuacFweBj9RCQhldgSIbBCAX-IjXctwWZ5hLwm2Gs6ZZm4_EE7oJPhrhflKr56Gx5Sj6hZBdUbhwTQ4dcIc-kkW3w5Oe3IuK5PBvF9SOdB2YaWZ9ZaI5FODred0_X6qssgFNcdqvTSlLn3DS_In9jg9DsKDDXH3IZcbloOWKg
Response
Success | Code: 200
[ { "endereco": "Helena Meira Lima" }, { "endereco": "Padre Nestor de Alencar" }, { "endereco": "Prof. Álvaro Lima" }, { "endereco": "Pedro Paes Mendonça " } ]
Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Query
KeyValueDescription
per_page20

Optional

page66

Optional

Response
Success | Code: 200
{ "current_page": 1, "data": [ { "id": 1, "nome": "Portal dos corais", "status": 0, "id_empresa": 1, "logradouro": null, "numero": null, "bairro": null, "cidade": null, "uf": null, "cep": null, "fone_1": null, "fone_2": null, "email": null, "cnpj": null, "id_administradora": null, "id_construtora": null, "id_supervisor_administradora": null, "metodo_cobranca": null, "contato": null, "qtd_apartamentos": null, "qtd_medidores_area_comum": null, "qtd_pocos": null, "endereco": null, "tipo_status": null, "id_concessionaria": null, "id_tarifa": null, "matricula_energia": null, "matricula_agua": null, "matricula_gas": null, "extra_1": null, "extra_2": null, "extra_3": null, "extra_4": null, "extra_5": null, "margem_diferenca": null, "matricula": null, "inscricao": null, "grupo": null, "sub_grupo": null, "responsavel": null, "firma": null, "gerencia_regional": null, "data_cliente": null, "dia_cobranca": null, "id_marketing": null, "situacao": 1, "emails_adicionais": null, "id_grupo": null, "img_principal": null, "img_destaque": null, "img_logomarca": null, "perfil_instagram": null, "perfil_facebook": null, "site": null, "interval_processed": false, "id_superlogica": null }, { "id": 8, "nome": "Cond. Guimarães Rosa", "status": 0, "id_empresa": 1, "logradouro": "Avenida", "numero": "123", "bairro": "Bairro", "cidade": "Cidade", "uf": "PE", "cep": "00000-000", "fone_1": "(00) 0000-0000", "fone_2": "(00) 0000-0000", "email": "email@email.com.br", "cnpj": "00.000.000/0000-00", "id_administradora": 8, "id_construtora": 2, "id_supervisor_administradora": null, "metodo_cobranca": 0, "contato": "Contato", "qtd_apartamentos": 10, "qtd_medidores_area_comum": 1, "qtd_pocos": 1, "endereco": "Boa Viagem", "tipo_status": 1, "id_concessionaria": null, "id_tarifa": null, "matricula_energia": null, "matricula_agua": null, "matricula_gas": null, "extra_1": null, "extra_2": null, "extra_3": null, "extra_4": null, "extra_5": null, "margem_diferenca": null, "matricula": null, "inscricao": null, "grupo": null, "sub_grupo": null, "responsavel": null, "firma": null, "gerencia_regional": null, "data_cliente": null, "dia_cobranca": null, "id_marketing": null, "situacao": 1, "emails_adicionais": null, "id_grupo": null, "img_principal": null, "img_destaque": null, "img_logomarca": null, "perfil_instagram": null, "perfil_facebook": null, "site": null, "interval_processed": false, "id_superlogica": null } ], "first_page_url": "http://localhost:8000/api/condominios?page=1", "from": 1, "last_page": 1118, "last_page_url": "http://localhost:8000/api/condominios?page=1118", "next_page_url": "http://localhost:8000/api/condominios?page=2", "path": "http://localhost:8000/api/condominios", "per_page": "2", "prev_page_url": null, "to": 2, "total": 2236 }
Description

Pega um condominio especifico.

Response
Success | Code: 200
{ "id": 1379, "nome": "Condomínio Vila do Chaves", "status": 1, "id_empresa": 1, "logradouro": "Rua", "numero": "24", "bairro": "Casa Amarela", "cidade": "Recife", "uf": "PE", "cep": "52070-005", "fone_1": "(81) 3126-2300", "fone_2": "(81) 4007-2008", "email": "sistemas@techmetria.com.br", "cnpj": "09.578.884/0001-30", "id_administradora": 13, "id_construtora": null, "id_supervisor_administradora": 43, "metodo_cobranca": null, "contato": "Roberto Fagundes", "qtd_apartamentos": 10, "qtd_medidores_area_comum": 1, "qtd_pocos": 1, "endereco": "Prof. Álvaro Lima", "tipo_status": 2, "id_concessionaria": null, "id_tarifa": null, "matricula_energia": "", "matricula_agua": "", "matricula_gas": "", "extra_1": "", "extra_2": "", "extra_3": "", "extra_4": "", "extra_5": "", "margem_diferenca": "70.00", "matricula": "", "inscricao": "", "grupo": null, "sub_grupo": "", "responsavel": "", "firma": "", "gerencia_regional": "", "data_cliente": "2008-05-27", "dia_cobranca": 10, "id_marketing": 86, "situacao": 1, "emails_adicionais": "gestao04@techmetria.com.br, gestao02@techmetria.com.br", "id_grupo": null, "img_principal": "img_principal-1379.png", "img_destaque": "img_destaque-1379.png", "img_logomarca": "img_logomarca-1379.png", "perfil_instagram": "", "perfil_facebook": "", "site": "", "interval_processed": true, "id_superlogica": null }
Description

Testa validação

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjUwM2JiZGIyNDgwZTQ3NWU2N2EzNTY0YjhmODc2NmE3NDk2YmQxMjNiNDk4NTFmNjkyYTFmYTkyMmYxNDI3YTY1Y2NjOGE4YzBmYjUxNDM2In0.eyJhdWQiOiIxIiwianRpIjoiNTAzYmJkYjI0ODBlNDc1ZTY3YTM1NjRiOGY4NzY2YTc0OTZiZDEyM2I0OTg1MWY2OTJhMWZhOTIyZjE0MjdhNjVjY2M4YThjMGZiNTE0MzYiLCJpYXQiOjE1NzY1MTYwMDQsIm5iZiI6MTU3NjUxNjAwNCwiZXhwIjoxNjA4MTM4NDA0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.HlK1xJqgxQav07MjSQnhD2W1GH0YfJjbezgA7T6d_L9Zk3UXCroVrfsktQXtygcU_FBTDp8WuuH1IoUT5dvt6FwSsIJlJcvhlJ5zA0nbqdfbL2XAatf1VL7pbryZUT_g6j6ivbcAdgRFEuB7eONlP_PIAynutClchX1z6nTfT-RqR68qdpxdqtiubEPiQ6EpY7MMMC0wcFlYC-mxHYca6XaeUqO6L0_bt_QQ4H5ZjYBipyLZE0geYnfZP10ABi9ukWgqRQHE1Re0Lz35WQTZ4tQOupdL6e-WSxPckHLrIZ4b_mzI2T-r6OusixFUSDVuCNmN0RnvvgGTVJt6TXgd81a6rCCQ6wzl-GXI22WwJKyO0O614gEtSTBE4bK0pg3cPcYOSMUhmEEngi2GgF_l5l32tKPtoX_SeTB2u0kx9pC51unRrXBukZfPIzEDA39w4Y7j810qPOi_Wmy-SQxuPtybjQJlpraFYRjQk0ms6ls882_eQqrEINHskiHQhp4kdSkuacFweBj9RCQhldgSIbBCAX-IjXctwWZ5hLwm2Gs6ZZm4_EE7oJPhrhflKr56Gx5Sj6hZBdUbhwTQ4dcIc-kkW3w5Oe3IuK5PBvF9SOdB2YaWZ9ZaI5FODred0_X6qssgFNcdqvTSlLn3DS_In9jg9DsKDDXH3IZcbloOWKg
Body
KeyValueDescription
addressProf. Álvaro Lima

Rua

bairroCasa Amarela

Bairro

id1379

Id do condomínio

Response
Failed | Code: 200
{ "error": "Não foi possível validar" }
Success | Code: 200
{ "success": "Validado com sucesso" }
Description

Cadastro de condomínio

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/x-www-form-urlencoded
Body
KeyValueDescription
nomeCondomínio de teste cadastrado na API
cnpj80.259.001/0001-94
cidadeRecife
ufPE
cep23132-999
enderecoExemplo de endereço
bairroCentro
numero123
emailcoisa@rmai.com
Response
Success | Code: 200
{ "success": "Salvo com sucesso!", "condominio": { "id": 2238, "nome": "Meu condomínio de teste" } }
New Condominio | Code: 200
{ "success": "Salvo com sucesso!", "condominio": { "id": 2244, "nome": "Condomínio de teste cadastrado na API" } }

Password Recovery 3

Recuperação da senha

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Body
KeyValueDescription
emailteste@test.com

required|email

Response
Create Reset Fail | Code: 200
{ "error": "User not found" }
Create Reset - Fails Validation | Code: 200
{ "error": { "email": [ "O campo email é obrigatório." ] } }
Create Reset Success | Code: 200
{ "success": "E-mail enviado", "email": { "success": "Success" } }
Description

Finaliza a redefinição de senha.

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Body
KeyValueDescription
tokenTOKEN_AQUI

Token recebido por e-mail

password123124214

Nova senha

password_confirmation123124214

Confirmação da nova senha

Response
Finish Reset - Fail token | Code: 200
{ "error": "Token não encontrado" }
Finish Reset - Fails Validation | Code: 200
{ "error": { "password": [ "O campo password é obrigatório." ], "password_confirmation": [ "Os campos password confirmation e password precisam ser iguais." ] } }
Finish Reset - Fail Validation | Code: 200
{ "password_confirmation": [ "The password confirmation and password must match." ] }
Finish Reset - Success | Code: 200
{ "success": "Senha cadastrada com sucesso!" }
Description

Verifica se o token de recuperação de senha é válido

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Response
Verify Reset Success | Code: 200
{ "success": "O token existe!" }
Verify Reset Fail | Code: 200
{ "error": "Token não encontrado" }

Payment Plan 6

Planos de pagamento do condomínio

Description

Cria um plano de pagamento

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Body
KeyValueDescription
nameTechmetria

string|required

visible1

numeric|required

avaliable1

numeric|required

price100

numeric|required

max_installments_number4

numeric|required - Máximo de parcelas

max_free_taxes_installments3

numeric|required - Máximo de parcelas sem juros

Response
Success | Code: 200
{ "success": "Salvo com sucesso!", "plan": { "name": "Techmetria", "visible": "1", "avaliable": "1", "price": "100", "max_installments_number": "4", "max_free_taxes_installments": "3", "updated_at": "2019-12-18 18:09:02", "created_at": "2019-12-18 18:09:02", "id": 1 } }
Description

Lista todos os planos cadastrados

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Response
Success | Code: 200
[ { "id": 1, "name": "Techmetria", "visible": 1, "avaliable": 1, "active": 1, "price": "100", "max_installments_number": 4, "max_free_taxes_installments": 3, "created_at": "2019-12-18 18:09:02", "updated_at": "2019-12-18 18:09:02" } ]
Description

Pega um plano específico

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Response
Success | Code: 200
{ "id": 1, "name": "Techmetria ", "visible": 1, "avaliable": 1, "active": 1, "price": "100", "max_installments_number": 4, "max_free_taxes_installments": 3, "created_at": "2019-12-18 18:09:02", "updated_at": "2019-12-18 18:09:02" }
Description

Lista os planos públicos (válido para usuários comuns)

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Response
Success | Code: 200
[ { "id": 1, "name": "Techmetria", "visible": 1, "avaliable": 1, "active": 1, "price": "100", "max_installments_number": 4, "max_free_taxes_installments": 3, "created_at": "2019-12-18 18:09:02", "updated_at": "2019-12-18 18:09:02" } ]
Headers
KeyValueDescription
Content-Typeapplication/x-www-form-urlencoded
Body
KeyValueDescription
nameTechmetria
visible1
avaliable1
price100
max_installments_number4
max_free_taxes_installments3
Response
Success | Code: 200
{ "success": "Editado com sucesso!" }
Description

Excluir um plano de pagamento

Response
Success | Code: 200
{ "success": "Excluído com sucesso" }

Payment Plan Features 6

Características do plano de pagamento.

Description

Lista as características

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Response
Success | Code: 200
[ { "id": 1, "payment_plan_id": 1, "name": "test ", "controller": "controller ", "method": "as ", "api_route": "a/s ", "active": 1, "created_at": "2019-12-20 17:31:16", "updated_at": "2019-12-20 17:31:16" } ]
Description

Pega uma Característica específica

Response
Get a specific Payment Plan Features | Code: 200
{ "id": 1, "payment_plan_id": 1, "name": "test ", "controller": "controller ", "method": "as ", "api_route": "a/s ", "active": 1, "created_at": "2019-12-20 17:31:16", "updated_at": "2019-12-20 17:31:16" }
Description

Lista os controllers e os métodos

Response
Get Controllers and Methods | Code: 200
[ { "controller": "Avisos", "methods": [ "Cadastrar", "Visualizar", "Editar", "Excluir" ] }, { "controller": "Ocorrências", "methods": [ "Cadastrar", "Visualizar", "Editar", "Excluir" ] } ]
Description

Cadastrar uma característica do plano de pagamento

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Body
KeyValueDescription
payment_plan_id1
nametest
controllercontroller
methodas
api_routea/s
Response
Success | Code: 200
{ "success": "Cadastrado com sucesso!", "feature": { "payment_plan_id": "1", "name": "test", "controller": "controller", "method": "as", "api_route": "a/s", "updated_at": "2019-12-20 17:31:16", "created_at": "2019-12-20 17:31:16", "id": 1 } }
Description

Edição de característica de plano de pagamento

Headers
KeyValueDescription
Content-Typeapplication/x-www-form-urlencoded
Body
KeyValueDescription
payment_plan_id1
nametest
controllercontroller
methodas
api_routea/s
Response
Success | Code: 200
{ "success": "Editado com sucesso!" }
Description

Apaga uma característica do plano de pagamento

Response
Success | Code: 200
{ "success": "Excluído com sucesso!" }

Roles (only administrator) 5

Papéis dos usuários.

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjUwM2JiZGIyNDgwZTQ3NWU2N2EzNTY0YjhmODc2NmE3NDk2YmQxMjNiNDk4NTFmNjkyYTFmYTkyMmYxNDI3YTY1Y2NjOGE4YzBmYjUxNDM2In0.eyJhdWQiOiIxIiwianRpIjoiNTAzYmJkYjI0ODBlNDc1ZTY3YTM1NjRiOGY4NzY2YTc0OTZiZDEyM2I0OTg1MWY2OTJhMWZhOTIyZjE0MjdhNjVjY2M4YThjMGZiNTE0MzYiLCJpYXQiOjE1NzY1MTYwMDQsIm5iZiI6MTU3NjUxNjAwNCwiZXhwIjoxNjA4MTM4NDA0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.HlK1xJqgxQav07MjSQnhD2W1GH0YfJjbezgA7T6d_L9Zk3UXCroVrfsktQXtygcU_FBTDp8WuuH1IoUT5dvt6FwSsIJlJcvhlJ5zA0nbqdfbL2XAatf1VL7pbryZUT_g6j6ivbcAdgRFEuB7eONlP_PIAynutClchX1z6nTfT-RqR68qdpxdqtiubEPiQ6EpY7MMMC0wcFlYC-mxHYca6XaeUqO6L0_bt_QQ4H5ZjYBipyLZE0geYnfZP10ABi9ukWgqRQHE1Re0Lz35WQTZ4tQOupdL6e-WSxPckHLrIZ4b_mzI2T-r6OusixFUSDVuCNmN0RnvvgGTVJt6TXgd81a6rCCQ6wzl-GXI22WwJKyO0O614gEtSTBE4bK0pg3cPcYOSMUhmEEngi2GgF_l5l32tKPtoX_SeTB2u0kx9pC51unRrXBukZfPIzEDA39w4Y7j810qPOi_Wmy-SQxuPtybjQJlpraFYRjQk0ms6ls882_eQqrEINHskiHQhp4kdSkuacFweBj9RCQhldgSIbBCAX-IjXctwWZ5hLwm2Gs6ZZm4_EE7oJPhrhflKr56Gx5Sj6hZBdUbhwTQ4dcIc-kkW3w5Oe3IuK5PBvF9SOdB2YaWZ9ZaI5FODred0_X6qssgFNcdqvTSlLn3DS_In9jg9DsKDDXH3IZcbloOWKg
Response
Results | Code: 200
[ { "id": 1, "name": "condomino", "level": 0, "active": 1, "created_at": "2019-12-12 13:47:23", "updated_at": "2019-12-12 13:47:23" }, { "id": 2, "name": "admin", "level": 0, "active": 1, "created_at": "2019-12-16 14:41:32", "updated_at": "2019-12-16 14:41:32" } ]
Description

Pega um papel.

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjUwM2JiZGIyNDgwZTQ3NWU2N2EzNTY0YjhmODc2NmE3NDk2YmQxMjNiNDk4NTFmNjkyYTFmYTkyMmYxNDI3YTY1Y2NjOGE4YzBmYjUxNDM2In0.eyJhdWQiOiIxIiwianRpIjoiNTAzYmJkYjI0ODBlNDc1ZTY3YTM1NjRiOGY4NzY2YTc0OTZiZDEyM2I0OTg1MWY2OTJhMWZhOTIyZjE0MjdhNjVjY2M4YThjMGZiNTE0MzYiLCJpYXQiOjE1NzY1MTYwMDQsIm5iZiI6MTU3NjUxNjAwNCwiZXhwIjoxNjA4MTM4NDA0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.HlK1xJqgxQav07MjSQnhD2W1GH0YfJjbezgA7T6d_L9Zk3UXCroVrfsktQXtygcU_FBTDp8WuuH1IoUT5dvt6FwSsIJlJcvhlJ5zA0nbqdfbL2XAatf1VL7pbryZUT_g6j6ivbcAdgRFEuB7eONlP_PIAynutClchX1z6nTfT-RqR68qdpxdqtiubEPiQ6EpY7MMMC0wcFlYC-mxHYca6XaeUqO6L0_bt_QQ4H5ZjYBipyLZE0geYnfZP10ABi9ukWgqRQHE1Re0Lz35WQTZ4tQOupdL6e-WSxPckHLrIZ4b_mzI2T-r6OusixFUSDVuCNmN0RnvvgGTVJt6TXgd81a6rCCQ6wzl-GXI22WwJKyO0O614gEtSTBE4bK0pg3cPcYOSMUhmEEngi2GgF_l5l32tKPtoX_SeTB2u0kx9pC51unRrXBukZfPIzEDA39w4Y7j810qPOi_Wmy-SQxuPtybjQJlpraFYRjQk0ms6ls882_eQqrEINHskiHQhp4kdSkuacFweBj9RCQhldgSIbBCAX-IjXctwWZ5hLwm2Gs6ZZm4_EE7oJPhrhflKr56Gx5Sj6hZBdUbhwTQ4dcIc-kkW3w5Oe3IuK5PBvF9SOdB2YaWZ9ZaI5FODred0_X6qssgFNcdqvTSlLn3DS_In9jg9DsKDDXH3IZcbloOWKg
Response
Result | Code: 200
{ "id": 1, "name": "condomino", "level": 0, "active": 1, "created_at": "2019-12-12 13:47:23", "updated_at": "2019-12-12 13:47:23" }
Description

Pega os usuários que tem esse papel

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjUwM2JiZGIyNDgwZTQ3NWU2N2EzNTY0YjhmODc2NmE3NDk2YmQxMjNiNDk4NTFmNjkyYTFmYTkyMmYxNDI3YTY1Y2NjOGE4YzBmYjUxNDM2In0.eyJhdWQiOiIxIiwianRpIjoiNTAzYmJkYjI0ODBlNDc1ZTY3YTM1NjRiOGY4NzY2YTc0OTZiZDEyM2I0OTg1MWY2OTJhMWZhOTIyZjE0MjdhNjVjY2M4YThjMGZiNTE0MzYiLCJpYXQiOjE1NzY1MTYwMDQsIm5iZiI6MTU3NjUxNjAwNCwiZXhwIjoxNjA4MTM4NDA0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.HlK1xJqgxQav07MjSQnhD2W1GH0YfJjbezgA7T6d_L9Zk3UXCroVrfsktQXtygcU_FBTDp8WuuH1IoUT5dvt6FwSsIJlJcvhlJ5zA0nbqdfbL2XAatf1VL7pbryZUT_g6j6ivbcAdgRFEuB7eONlP_PIAynutClchX1z6nTfT-RqR68qdpxdqtiubEPiQ6EpY7MMMC0wcFlYC-mxHYca6XaeUqO6L0_bt_QQ4H5ZjYBipyLZE0geYnfZP10ABi9ukWgqRQHE1Re0Lz35WQTZ4tQOupdL6e-WSxPckHLrIZ4b_mzI2T-r6OusixFUSDVuCNmN0RnvvgGTVJt6TXgd81a6rCCQ6wzl-GXI22WwJKyO0O614gEtSTBE4bK0pg3cPcYOSMUhmEEngi2GgF_l5l32tKPtoX_SeTB2u0kx9pC51unRrXBukZfPIzEDA39w4Y7j810qPOi_Wmy-SQxuPtybjQJlpraFYRjQk0ms6ls882_eQqrEINHskiHQhp4kdSkuacFweBj9RCQhldgSIbBCAX-IjXctwWZ5hLwm2Gs6ZZm4_EE7oJPhrhflKr56Gx5Sj6hZBdUbhwTQ4dcIc-kkW3w5Oe3IuK5PBvF9SOdB2YaWZ9ZaI5FODred0_X6qssgFNcdqvTSlLn3DS_In9jg9DsKDDXH3IZcbloOWKg
Response
Results | Code: 200
[ { "id": 1, "role_id": 1, "field_name": "condominio_id", "required": 1, "active": 1, "created_at": "2019-12-12 13:47:57", "updated_at": "2019-12-12 13:47:57" } ]
Results | Code: 200
[ { "id": 1, "user_id": 1, "role_id": 1, "active": 1, "created_at": "2019-12-12 13:48:16", "updated_at": "2019-12-12 13:48:16", "user": { "id": 1, "name": "Jayr A Pereira", "email": "sistemas@techmetria.com.br", "email_verified_at": null, "created_at": "2019-12-12 12:15:20", "updated_at": "2019-12-12 12:15:20", "active": 1 } } ]
Description

Cria um novo papel de usuário.

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjUwM2JiZGIyNDgwZTQ3NWU2N2EzNTY0YjhmODc2NmE3NDk2YmQxMjNiNDk4NTFmNjkyYTFmYTkyMmYxNDI3YTY1Y2NjOGE4YzBmYjUxNDM2In0.eyJhdWQiOiIxIiwianRpIjoiNTAzYmJkYjI0ODBlNDc1ZTY3YTM1NjRiOGY4NzY2YTc0OTZiZDEyM2I0OTg1MWY2OTJhMWZhOTIyZjE0MjdhNjVjY2M4YThjMGZiNTE0MzYiLCJpYXQiOjE1NzY1MTYwMDQsIm5iZiI6MTU3NjUxNjAwNCwiZXhwIjoxNjA4MTM4NDA0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.HlK1xJqgxQav07MjSQnhD2W1GH0YfJjbezgA7T6d_L9Zk3UXCroVrfsktQXtygcU_FBTDp8WuuH1IoUT5dvt6FwSsIJlJcvhlJ5zA0nbqdfbL2XAatf1VL7pbryZUT_g6j6ivbcAdgRFEuB7eONlP_PIAynutClchX1z6nTfT-RqR68qdpxdqtiubEPiQ6EpY7MMMC0wcFlYC-mxHYca6XaeUqO6L0_bt_QQ4H5ZjYBipyLZE0geYnfZP10ABi9ukWgqRQHE1Re0Lz35WQTZ4tQOupdL6e-WSxPckHLrIZ4b_mzI2T-r6OusixFUSDVuCNmN0RnvvgGTVJt6TXgd81a6rCCQ6wzl-GXI22WwJKyO0O614gEtSTBE4bK0pg3cPcYOSMUhmEEngi2GgF_l5l32tKPtoX_SeTB2u0kx9pC51unRrXBukZfPIzEDA39w4Y7j810qPOi_Wmy-SQxuPtybjQJlpraFYRjQk0ms6ls882_eQqrEINHskiHQhp4kdSkuacFweBj9RCQhldgSIbBCAX-IjXctwWZ5hLwm2Gs6ZZm4_EE7oJPhrhflKr56Gx5Sj6hZBdUbhwTQ4dcIc-kkW3w5Oe3IuK5PBvF9SOdB2YaWZ9ZaI5FODred0_X6qssgFNcdqvTSlLn3DS_In9jg9DsKDDXH3IZcbloOWKg
Query
KeyValueDescription
nametest

string|required

level1

numeric|nullable

Response
Validation error | Code: 200
{ "error": { "name": [ "O name informado já existe" ] } }
Success | Code: 200
{ "success": "Cadastrado com sucesso", "role": { "name": "test", "updated_at": "2019-12-16 18:24:06", "created_at": "2019-12-16 18:24:06", "id": 3 } }
Description

Editar papel

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjUwM2JiZGIyNDgwZTQ3NWU2N2EzNTY0YjhmODc2NmE3NDk2YmQxMjNiNDk4NTFmNjkyYTFmYTkyMmYxNDI3YTY1Y2NjOGE4YzBmYjUxNDM2In0.eyJhdWQiOiIxIiwianRpIjoiNTAzYmJkYjI0ODBlNDc1ZTY3YTM1NjRiOGY4NzY2YTc0OTZiZDEyM2I0OTg1MWY2OTJhMWZhOTIyZjE0MjdhNjVjY2M4YThjMGZiNTE0MzYiLCJpYXQiOjE1NzY1MTYwMDQsIm5iZiI6MTU3NjUxNjAwNCwiZXhwIjoxNjA4MTM4NDA0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.HlK1xJqgxQav07MjSQnhD2W1GH0YfJjbezgA7T6d_L9Zk3UXCroVrfsktQXtygcU_FBTDp8WuuH1IoUT5dvt6FwSsIJlJcvhlJ5zA0nbqdfbL2XAatf1VL7pbryZUT_g6j6ivbcAdgRFEuB7eONlP_PIAynutClchX1z6nTfT-RqR68qdpxdqtiubEPiQ6EpY7MMMC0wcFlYC-mxHYca6XaeUqO6L0_bt_QQ4H5ZjYBipyLZE0geYnfZP10ABi9ukWgqRQHE1Re0Lz35WQTZ4tQOupdL6e-WSxPckHLrIZ4b_mzI2T-r6OusixFUSDVuCNmN0RnvvgGTVJt6TXgd81a6rCCQ6wzl-GXI22WwJKyO0O614gEtSTBE4bK0pg3cPcYOSMUhmEEngi2GgF_l5l32tKPtoX_SeTB2u0kx9pC51unRrXBukZfPIzEDA39w4Y7j810qPOi_Wmy-SQxuPtybjQJlpraFYRjQk0ms6ls882_eQqrEINHskiHQhp4kdSkuacFweBj9RCQhldgSIbBCAX-IjXctwWZ5hLwm2Gs6ZZm4_EE7oJPhrhflKr56Gx5Sj6hZBdUbhwTQ4dcIc-kkW3w5Oe3IuK5PBvF9SOdB2YaWZ9ZaI5FODred0_X6qssgFNcdqvTSlLn3DS_In9jg9DsKDDXH3IZcbloOWKg
Body
KeyValueDescription
level1

required|numeric

Response
Success | Code: 200
{ "success": "Editado com sucesso!" }

Roles (only administrator)/Role Restrictions 4

Description

Pega as restrições de cada papel

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjUwM2JiZGIyNDgwZTQ3NWU2N2EzNTY0YjhmODc2NmE3NDk2YmQxMjNiNDk4NTFmNjkyYTFmYTkyMmYxNDI3YTY1Y2NjOGE4YzBmYjUxNDM2In0.eyJhdWQiOiIxIiwianRpIjoiNTAzYmJkYjI0ODBlNDc1ZTY3YTM1NjRiOGY4NzY2YTc0OTZiZDEyM2I0OTg1MWY2OTJhMWZhOTIyZjE0MjdhNjVjY2M4YThjMGZiNTE0MzYiLCJpYXQiOjE1NzY1MTYwMDQsIm5iZiI6MTU3NjUxNjAwNCwiZXhwIjoxNjA4MTM4NDA0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.HlK1xJqgxQav07MjSQnhD2W1GH0YfJjbezgA7T6d_L9Zk3UXCroVrfsktQXtygcU_FBTDp8WuuH1IoUT5dvt6FwSsIJlJcvhlJ5zA0nbqdfbL2XAatf1VL7pbryZUT_g6j6ivbcAdgRFEuB7eONlP_PIAynutClchX1z6nTfT-RqR68qdpxdqtiubEPiQ6EpY7MMMC0wcFlYC-mxHYca6XaeUqO6L0_bt_QQ4H5ZjYBipyLZE0geYnfZP10ABi9ukWgqRQHE1Re0Lz35WQTZ4tQOupdL6e-WSxPckHLrIZ4b_mzI2T-r6OusixFUSDVuCNmN0RnvvgGTVJt6TXgd81a6rCCQ6wzl-GXI22WwJKyO0O614gEtSTBE4bK0pg3cPcYOSMUhmEEngi2GgF_l5l32tKPtoX_SeTB2u0kx9pC51unRrXBukZfPIzEDA39w4Y7j810qPOi_Wmy-SQxuPtybjQJlpraFYRjQk0ms6ls882_eQqrEINHskiHQhp4kdSkuacFweBj9RCQhldgSIbBCAX-IjXctwWZ5hLwm2Gs6ZZm4_EE7oJPhrhflKr56Gx5Sj6hZBdUbhwTQ4dcIc-kkW3w5Oe3IuK5PBvF9SOdB2YaWZ9ZaI5FODred0_X6qssgFNcdqvTSlLn3DS_In9jg9DsKDDXH3IZcbloOWKg
Response
Results | Code: 200
[ { "id": 1, "role_id": 1, "field_name": "condominio_id", "required": 1, "active": 1, "created_at": "2019-12-12 13:47:57", "updated_at": "2019-12-12 13:47:57" } ]
Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjUwM2JiZGIyNDgwZTQ3NWU2N2EzNTY0YjhmODc2NmE3NDk2YmQxMjNiNDk4NTFmNjkyYTFmYTkyMmYxNDI3YTY1Y2NjOGE4YzBmYjUxNDM2In0.eyJhdWQiOiIxIiwianRpIjoiNTAzYmJkYjI0ODBlNDc1ZTY3YTM1NjRiOGY4NzY2YTc0OTZiZDEyM2I0OTg1MWY2OTJhMWZhOTIyZjE0MjdhNjVjY2M4YThjMGZiNTE0MzYiLCJpYXQiOjE1NzY1MTYwMDQsIm5iZiI6MTU3NjUxNjAwNCwiZXhwIjoxNjA4MTM4NDA0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.HlK1xJqgxQav07MjSQnhD2W1GH0YfJjbezgA7T6d_L9Zk3UXCroVrfsktQXtygcU_FBTDp8WuuH1IoUT5dvt6FwSsIJlJcvhlJ5zA0nbqdfbL2XAatf1VL7pbryZUT_g6j6ivbcAdgRFEuB7eONlP_PIAynutClchX1z6nTfT-RqR68qdpxdqtiubEPiQ6EpY7MMMC0wcFlYC-mxHYca6XaeUqO6L0_bt_QQ4H5ZjYBipyLZE0geYnfZP10ABi9ukWgqRQHE1Re0Lz35WQTZ4tQOupdL6e-WSxPckHLrIZ4b_mzI2T-r6OusixFUSDVuCNmN0RnvvgGTVJt6TXgd81a6rCCQ6wzl-GXI22WwJKyO0O614gEtSTBE4bK0pg3cPcYOSMUhmEEngi2GgF_l5l32tKPtoX_SeTB2u0kx9pC51unRrXBukZfPIzEDA39w4Y7j810qPOi_Wmy-SQxuPtybjQJlpraFYRjQk0ms6ls882_eQqrEINHskiHQhp4kdSkuacFweBj9RCQhldgSIbBCAX-IjXctwWZ5hLwm2Gs6ZZm4_EE7oJPhrhflKr56Gx5Sj6hZBdUbhwTQ4dcIc-kkW3w5Oe3IuK5PBvF9SOdB2YaWZ9ZaI5FODred0_X6qssgFNcdqvTSlLn3DS_In9jg9DsKDDXH3IZcbloOWKg
Body
KeyValueDescription
field_nameteste2

required|string

required1

nullable|numeric

role_id1

required|numeric

Response
Already exists | Code: 200
{ "error": "Já existe uma restrição cadastrada com esse nome para este papel!" }
Success | Code: 200
{ "success": "Restrição cadastrada com sucesso!", "role_restriction": { "field_name": "teste2", "required": "1", "role_id": "1", "updated_at": "2019-12-16 19:46:55", "created_at": "2019-12-16 19:46:55", "id": 3 } }
Description

Editar restrição de um papel

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjUwM2JiZGIyNDgwZTQ3NWU2N2EzNTY0YjhmODc2NmE3NDk2YmQxMjNiNDk4NTFmNjkyYTFmYTkyMmYxNDI3YTY1Y2NjOGE4YzBmYjUxNDM2In0.eyJhdWQiOiIxIiwianRpIjoiNTAzYmJkYjI0ODBlNDc1ZTY3YTM1NjRiOGY4NzY2YTc0OTZiZDEyM2I0OTg1MWY2OTJhMWZhOTIyZjE0MjdhNjVjY2M4YThjMGZiNTE0MzYiLCJpYXQiOjE1NzY1MTYwMDQsIm5iZiI6MTU3NjUxNjAwNCwiZXhwIjoxNjA4MTM4NDA0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.HlK1xJqgxQav07MjSQnhD2W1GH0YfJjbezgA7T6d_L9Zk3UXCroVrfsktQXtygcU_FBTDp8WuuH1IoUT5dvt6FwSsIJlJcvhlJ5zA0nbqdfbL2XAatf1VL7pbryZUT_g6j6ivbcAdgRFEuB7eONlP_PIAynutClchX1z6nTfT-RqR68qdpxdqtiubEPiQ6EpY7MMMC0wcFlYC-mxHYca6XaeUqO6L0_bt_QQ4H5ZjYBipyLZE0geYnfZP10ABi9ukWgqRQHE1Re0Lz35WQTZ4tQOupdL6e-WSxPckHLrIZ4b_mzI2T-r6OusixFUSDVuCNmN0RnvvgGTVJt6TXgd81a6rCCQ6wzl-GXI22WwJKyO0O614gEtSTBE4bK0pg3cPcYOSMUhmEEngi2GgF_l5l32tKPtoX_SeTB2u0kx9pC51unRrXBukZfPIzEDA39w4Y7j810qPOi_Wmy-SQxuPtybjQJlpraFYRjQk0ms6ls882_eQqrEINHskiHQhp4kdSkuacFweBj9RCQhldgSIbBCAX-IjXctwWZ5hLwm2Gs6ZZm4_EE7oJPhrhflKr56Gx5Sj6hZBdUbhwTQ4dcIc-kkW3w5Oe3IuK5PBvF9SOdB2YaWZ9ZaI5FODred0_X6qssgFNcdqvTSlLn3DS_In9jg9DsKDDXH3IZcbloOWKg
Body
KeyValueDescription
required1

required|numeric

Response
Result | Code: 200
{ "success": "Salvo com sucesso!" }
Description

Apagar restrições de papel

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjUwM2JiZGIyNDgwZTQ3NWU2N2EzNTY0YjhmODc2NmE3NDk2YmQxMjNiNDk4NTFmNjkyYTFmYTkyMmYxNDI3YTY1Y2NjOGE4YzBmYjUxNDM2In0.eyJhdWQiOiIxIiwianRpIjoiNTAzYmJkYjI0ODBlNDc1ZTY3YTM1NjRiOGY4NzY2YTc0OTZiZDEyM2I0OTg1MWY2OTJhMWZhOTIyZjE0MjdhNjVjY2M4YThjMGZiNTE0MzYiLCJpYXQiOjE1NzY1MTYwMDQsIm5iZiI6MTU3NjUxNjAwNCwiZXhwIjoxNjA4MTM4NDA0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.HlK1xJqgxQav07MjSQnhD2W1GH0YfJjbezgA7T6d_L9Zk3UXCroVrfsktQXtygcU_FBTDp8WuuH1IoUT5dvt6FwSsIJlJcvhlJ5zA0nbqdfbL2XAatf1VL7pbryZUT_g6j6ivbcAdgRFEuB7eONlP_PIAynutClchX1z6nTfT-RqR68qdpxdqtiubEPiQ6EpY7MMMC0wcFlYC-mxHYca6XaeUqO6L0_bt_QQ4H5ZjYBipyLZE0geYnfZP10ABi9ukWgqRQHE1Re0Lz35WQTZ4tQOupdL6e-WSxPckHLrIZ4b_mzI2T-r6OusixFUSDVuCNmN0RnvvgGTVJt6TXgd81a6rCCQ6wzl-GXI22WwJKyO0O614gEtSTBE4bK0pg3cPcYOSMUhmEEngi2GgF_l5l32tKPtoX_SeTB2u0kx9pC51unRrXBukZfPIzEDA39w4Y7j810qPOi_Wmy-SQxuPtybjQJlpraFYRjQk0ms6ls882_eQqrEINHskiHQhp4kdSkuacFweBj9RCQhldgSIbBCAX-IjXctwWZ5hLwm2Gs6ZZm4_EE7oJPhrhflKr56Gx5Sj6hZBdUbhwTQ4dcIc-kkW3w5Oe3IuK5PBvF9SOdB2YaWZ9ZaI5FODred0_X6qssgFNcdqvTSlLn3DS_In9jg9DsKDDXH3IZcbloOWKg

Users 10

Description

Cadastro de usuários

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
Body
KeyValueDescription
nametest

Nome do usuário

emailtest@test.com3w

E-mail precisa ser único

password123456

Senha

password_confirmation123456

Confirmação de Senha

tokene3Mq0W3KszlL94ohrILT2maGpQ1pDP

Token de pré cadastro (não obrigatório)

Response
User Register Success | Code: 200
{ "success": "Cadastrado com sucesso!", "email": { "success": "Success" } }
User Register - Fail | Code: 200
{ "error": { "email": [ "O campo email é obrigatório." ], "password_confirmation": [ "Os campos password confirmation e password precisam ser os mesmos." ] } }
Description

Login na API

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
Body
KeyValueDescription
emailtest@test.com
password123456
Response
Login Unauthorized | Code: 401
{ "error": "Unauthorized.", "message": "E-mail não cadastrado" }
Login - Fails Validation | Code: 200
{ "error": { "password": [ "O campo password é obrigatório." ] } }
Login Success | Code: 200
{ "id": 6, "name": "test", "email": "test@test.com", "email_verified_at": "2019-12-16 13:41:47", "created_at": "2019-12-16 12:57:43", "updated_at": "2019-12-16 19:05:45", "active": 1, "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6Ijk2MGMyNWRiYjBiYTMwZGE1MTBlYmUyNTY1MjA3NzZkNmQyMzIzMTYwOWU1MmY2Nzg2MDA4NDc2ZWY2ZDFjNzZkMzdkYjI1NDk3NmU3MTA5In0.eyJhdWQiOiIxIiwianRpIjoiOTYwYzI1ZGJiMGJhMzBkYTUxMGViZTI1NjUyMDc3NmQ2ZDIzMjMxNjA5ZTUyZjY3ODYwMDg0NzZlZjZkMWM3NmQzN2RiMjU0OTc2ZTcxMDkiLCJpYXQiOjE1Nzk1MjA0MDUsIm5iZiI6MTU3OTUyMDQwNSwiZXhwIjoxNjExMTQyODA1LCJzdWIiOiI2Iiwic2NvcGVzIjpbXX0.oIgOKd0FBciL_l3orJF0SNdnO9NMwWA5yHjpJJkQfGoKtPiNdkRKELB12c7kfpgIgfapQLIKAWYZTXlUc96IFEfngPHunmC54f9Laj7NGzrCVAc1_2xiMFKtmtKwnIcVS1I5LV-MA_X6ympLobNolhuxnAIZL1z4yh7vuebA4SyJZQC5tHYhzNRUN5Snh1eUTx6OmaC1iLcj8PSXnstAexDJiHuMzvMRtTa3sk_7w53zPhQ4l9fLN1PVUoJcm1XIDKPkpXcOJRJyLuG4KEi17QnKtHURvsQs1j9fswuViAYqc_FCf_T8yhOIktP5hY-T_vtcdTmrbtJAUXiPB1a241Jyh-YTV8tOXOeWdR9-hUJbbyhtmuMRGnKz4-R8VGDC8gKzzIU-9Er5N6jhlCRX-OThgb0D1CmnOnwPfD6GQj-ToM4CowL5xqlqwkf9shMYF4iU7XQxFuY7dNHkKCpi6dqT7K889vcKUKjm7qsXd-ANRurG74q4M5cJ4HFFAr9BBTlYWY1ni9bOtesbbDmDGwbYHSRbeQXAybqutxm5uIsR7e5kCA2Ro_uEg3JH1ynt_Ko_wjYB5xssgge5YDZfDAjELFAejyBdgrfmiUkaY1hc_uorD_T32Rwb6d3bq43USyudrP6NP7Znk9QfNNoUnPYkH3wrVutsen-fUHZR890" }
Description

sair

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Response
User Logout | Code: 200
{ "message": "Successfully logged out" }
Description

Login social (Google e Facebook)

Query
KeyValueDescription
tokender12e3
Description

Ver informações do usuário

Headers
KeyValueDescription
Content-Typeapplication/json
Acceptapplication/json
AuthorizationBearer [TOKEN_AQUI]
Response
Get User Data Success | Code: 200
{ "id": 6, "name": "test", "email": "test@test.com", "email_verified_at": null, "created_at": "2019-12-16 12:57:43", "updated_at": "2019-12-16 12:57:43" }
Get User Data Fail (Unauthenticated) | Code: 401
{ "message": "Unauthenticated." }
Description

Confirma e-mail de um novo usuário

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Response
E-mail Confirmation - Success | Code: 200
{ "success": "E-mail confirmado com sucesso!" }
E-mail Confirmation - Token not found | Code: 200
{ "error": "Token não encontrado" }
Description

Pega papéis do usuário logado

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjUwM2JiZGIyNDgwZTQ3NWU2N2EzNTY0YjhmODc2NmE3NDk2YmQxMjNiNDk4NTFmNjkyYTFmYTkyMmYxNDI3YTY1Y2NjOGE4YzBmYjUxNDM2In0.eyJhdWQiOiIxIiwianRpIjoiNTAzYmJkYjI0ODBlNDc1ZTY3YTM1NjRiOGY4NzY2YTc0OTZiZDEyM2I0OTg1MWY2OTJhMWZhOTIyZjE0MjdhNjVjY2M4YThjMGZiNTE0MzYiLCJpYXQiOjE1NzY1MTYwMDQsIm5iZiI6MTU3NjUxNjAwNCwiZXhwIjoxNjA4MTM4NDA0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.HlK1xJqgxQav07MjSQnhD2W1GH0YfJjbezgA7T6d_L9Zk3UXCroVrfsktQXtygcU_FBTDp8WuuH1IoUT5dvt6FwSsIJlJcvhlJ5zA0nbqdfbL2XAatf1VL7pbryZUT_g6j6ivbcAdgRFEuB7eONlP_PIAynutClchX1z6nTfT-RqR68qdpxdqtiubEPiQ6EpY7MMMC0wcFlYC-mxHYca6XaeUqO6L0_bt_QQ4H5ZjYBipyLZE0geYnfZP10ABi9ukWgqRQHE1Re0Lz35WQTZ4tQOupdL6e-WSxPckHLrIZ4b_mzI2T-r6OusixFUSDVuCNmN0RnvvgGTVJt6TXgd81a6rCCQ6wzl-GXI22WwJKyO0O614gEtSTBE4bK0pg3cPcYOSMUhmEEngi2GgF_l5l32tKPtoX_SeTB2u0kx9pC51unRrXBukZfPIzEDA39w4Y7j810qPOi_Wmy-SQxuPtybjQJlpraFYRjQk0ms6ls882_eQqrEINHskiHQhp4kdSkuacFweBj9RCQhldgSIbBCAX-IjXctwWZ5hLwm2Gs6ZZm4_EE7oJPhrhflKr56Gx5Sj6hZBdUbhwTQ4dcIc-kkW3w5Oe3IuK5PBvF9SOdB2YaWZ9ZaI5FODred0_X6qssgFNcdqvTSlLn3DS_In9jg9DsKDDXH3IZcbloOWKg
Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/json
Response
Permission | Code: 200
{ "role": "operador", "emailVerified": false }
Permission | Code: 200
{ "role": "condomino" }
Description

Edição da senha feita pelo próprio usuário.

Headers
KeyValueDescription
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjA4OGQxOTY3ZmM3MjRiNjUwMTBmYTZkOTYxZjVhOWYwMmY0ZWIxNTE2Njc5NGUzNzNmNmJmZmRmZWE2YTU3MjYyZmVmY2NiZTY4NDdiMzZhIn0.eyJhdWQiOiIxIiwianRpIjoiMDg4ZDE5NjdmYzcyNGI2NTAxMGZhNmQ5NjFmNWE5ZjAyZjRlYjE1MTY2Nzk0ZTM3M2Y2YmZmZGZlYTZhNTcyNjJmZWZjY2JlNjg0N2IzNmEiLCJpYXQiOjE1NzY1MTUwNzcsIm5iZiI6MTU3NjUxNTA3NywiZXhwIjoxNjA4MTM3NDc3LCJzdWIiOiI2Iiwic2NvcGVzIjpbXX0.R9iUTr43PySRQCYb6C-uqlkT15oujsTyrGFy-meOPqMtpC6jn0ZGKjEuffb_HgELbQ_qiRMIdn0mU9S3pgateu0nFEUfIrUtvwfU_Z8cXrmUVdFhDTQXsdy2VC3ORUyx7ZcvCLzIcxP_i_pXgWWdUoSctTY1H-GlGdWyimyHdAZ1NhE1rMe1-QeL6Zw5W2HyT8MHVErPzWYrfVyyQs5GsS9M0XWqK3GvwFXo-GnOMGGo5cFOe44NfE0YIU_DyUtkSntXeS-2DMgG_p90rC5wg8-v2YlcEFW297AoucWKbOn69UNV0YyU3kMXCUv1P3P6Eqv4N8TRFYoKuufksptpIrUSAN1DFhdwvORDfnin4GoS5Pxm7IOQRP63YTmVUSE2Qst0xvfI13_5k94ZuC8VaBF28sqTuiseVYdNNC4Ow__JIjA8Gz3k2qoHXzzFLGQKwoJJqrN-QdMbdQuuZ6WmWfkBx6i0g_po2qfiCw9qX95JmC2-MBHWpANJs5NvqGKL2n6Dc3h1lfwp3KsDOixi34eUvyGaWU_GLPIsDtw6QQAEdfZaZ-iRGHWfvwGMqLalFVZxwW0dV_RueBBa5sxy1C1fkbxTXpeEwpqHkgndBD-fq5o9r8kQmkdQ-s-7yucg3OC5tdOAf-1euYFUWM5oGg6VVmjZ5SBKwwwCtUd0cMw
Content-Typeapplication/x-www-form-urlencoded
Body
KeyValueDescription
old_password123124214
password123456
password_confirmation123456
Response
Success | Code: 200
{ "success": "Senha alterada com sucesso" }
Old password wrong | Code: 200
{ "error": "A senha informada não está correta!" }
Description

Mudança de senha do usuário feita pelo administrador

Headers
KeyValueDescription
Acceptapplication/json
Content-Typeapplication/x-www-form-urlencoded
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjA2ZmU1Yzg1Y2Y0ZmRhMmJiODU3MDRlNzAzZDFjMjFlYjUxNjM3YmQ3MWM4Y2U4ZjYzYjZmOWMzOTE1NjM5ZjgyN2ZjMDMwZjgxOGM1MzZkIn0.eyJhdWQiOiIxIiwianRpIjoiMDZmZTVjODVjZjRmZGEyYmI4NTcwNGU3MDNkMWMyMWViNTE2MzdiZDcxYzhjZThmNjNiNmY5YzM5MTU2MzlmODI3ZmMwMzBmODE4YzUzNmQiLCJpYXQiOjE1NzY1MTU2OTksIm5iZiI6MTU3NjUxNTY5OSwiZXhwIjoxNjA4MTM4MDk5LCJzdWIiOiI2Iiwic2NvcGVzIjpbXX0.x-zmZh9AmKzRmLPva30kLOfBVpNtViWgOgDSMHXkTBNeGeLQmELM4bU66vUzaYynrOuRk1SsIPUQYXszx84Z_DvY68m7VNiej4bXu8DkXhKYSaMdYkwytLM18ARGVAwhv47nm9gH4Eg3DcDPDI47TS6MH9JK5vvB8hGkhq7FlOhFqWewip2uMl0zM2Rvx4JZSxILIUKLepzbj4MUHrnkmnKz58foyx8scaj1yvgVkYRV3Gdm7SqKdmwHSMt5sML0DnSY9xbU_C0Rx6ZfeXclOFB0WCTI5V7njCfXVIjHU9Iq95kCj2MrnoP2H_aSvJxaCcrNk7koZHVsy1RIo2__3iDctQ_3hB1kiXxcVvasvRlvS5PjA-eNJ2sSfRbKLWNF8R7o_S2C13F7jiXL2TleEE3xSG0tAqsCyHDPseCE22D6D8F9eq8yHmuQmLJX_u69LvdDW_IRIl84jY9QtBPg9K3Sb3bLwp3031Jru6K-l9uaZ9qA-JTFbCPYP4JlZpmhwCK2drMmrO7iIYLvOTU_51lpGBTdlQIjUtGG2UdYODkV1lCbqUVdV8Ozvl2nIc26Yy7otnEJZdBDM4KRWyiFw7O7IXIPDkVaANm3OIjFFUn1rFpDTYnUNam6AoTI1ArrDw0FSY1yijClavKY5rEinwXLz_Y7aWMicQ5EXFIwdDw
Body
KeyValueDescription
password123456
password_confirmation123456
Response
Success | Code: 200
{ "success": "Senha alterada com sucesso" }
No permission (is not administrator) | Code: 401
{ "error": "Você não tem permissão para fazer isso" }