Insomnia_2020-08-27.json

{"_type":"export","__export_format":4,"__export_date":"2020-08-28T19:23:22.115Z","__export_source":"insomnia.desktop.app:v2020.3.3","resources":[{"_id":"req_7369f8c3beba4d7082d0e709eee63d5f","authentication":{},"body":{"mimeType":"application/json","text":"{\n\t\"email\": \"email@email.com\",\n\t\"password\": \"veryhardpassword\"\n}"},"created":1598562361183,"description":"### Descrição\n\n> Recurso responsável por cadastrar e inserir um usuário no banco de dados.\n\n<!-- RESPONSE -->\n{\n  \"id\": 1,\n  \"email\": \"email@email.com\",\n  \"password_hash\": \"$2a$08$B5XMAm1hoKmV1xACRA/DqOzkT/XTu5G9x3PFOsSURBobR4qJ0jcjW\",\n}\n<!-- ENDRESPONSE -->","headers":[{"id":"pair_299cb2408a824b189247d58db8492bb6","name":"Content-Type","value":"application/json"}],"isPrivate":false,"metaSortKey":-1598562361183,"method":"POST","modified":1598576497616,"name":"Cadastrar usuário","parameters":[],"parentId":"fld_bf6568639658452b9c1fde498f91ef19","settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingFollowRedirects":"global","settingRebuildPath":true,"settingSendCookies":true,"settingStoreCookies":true,"url":"{{ baseUrl }}/cadastro","_type":"request"},{"_id":"fld_bf6568639658452b9c1fde498f91ef19","created":1598562347979,"description":"","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1598562504905,"modified":1598562514552,"name":"User","parentId":"wrk_1232ccd2368d4561bbcf65cd441b6cc7","_type":"request_group"},{"_id":"wrk_1232ccd2368d4561bbcf65cd441b6cc7","created":1580836422352,"description":"![logo](https://user-images.githubusercontent.com/44507419/91507497-616ff400-e8ab-11ea-80e6-c29dfa5da930.png)\n\n\n\n# Introdução\n\nA interface de serviços da API público provê uma API REST para efetuar operações e consultas na base de dados sobre Ocorrências Criminais, SINESP - Ministério da Justiça.\n\nA API possui um sistema de autenticação para maior segurança.\n\nAqui você encontrará todas as informações necessárias para integrar seu sistema com a API público, CRIME.DATA.\n\n# Chaves de Acesso\n\nPara conectar-se a API precisará primeiro autenticar-se com:\n  * __Email__\n  * __Senha__\n\nNa rota /login, que retornará um:\n  * __Token__\n\n# Autenticação\n\nUsamos o jwt token como forma de autenticação. Ele deve ser passado como cabeçalho (Header) nas rotas protegidas que necessitem obrigatoriamente dele.\n\nO JSON Web Token é um padrão da Internet para a criação de dados com assinatura opcional e/ou criptografia, cuja sua payload contém o JSON que afirma algum número de declarações.\nMais informações sobre o JSON Web Token poderão ser encontradas no site [jsonwebtoken.io](https://www.jsonwebtoken.io/).\n\n# Formato das Respostas\n\nTodos os recursos suportam o envio de respostas no formato JSON. Para obter a resposta basta enviar uma requisição HTTP.\n\n# Recursos\n\nAbaixo estão listados os recursos disponivéis pela API.\n","modified":1598639757452,"name":"CRIME.DATA","parentId":null,"scope":null,"_type":"workspace"},{"_id":"req_2f1348fbd482466a82e66c4425d6b05e","authentication":{},"body":{"mimeType":"application/json","text":"{\n\t\"email\": \"email@email.com\",\n\t\"password\": \"veryhardpassword\"\n}"},"created":1598562524088,"description":"### Descrição\n\n> Recurso responsável por logar o usuário no sistema e retorná-lo o token de acesso.\n\n<!-- RESPONSE -->\n{\n  \"id\": 1,\n  \"email\": \"sergio.s.neto@alu.ufc.br\",\n  \"name\": \"Sergio\",\n  \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MiwiaWF0IjoxNTk4NTYyNTYwLCJleHAiOjE1OTkxNjczNjB9.BC9zTwZs-WPm7K2oqaHaOXV3zDBqIXE0gqx0WDvovCM\"\n}\n<!-- ENDRESPONSE -->","headers":[{"id":"pair_b951eb655ede41bbbb5d598da06fcf3c","name":"Content-Type","value":"application/json"}],"isPrivate":false,"metaSortKey":-1598562524088,"method":"POST","modified":1598640113340,"name":"Login","parameters":[],"parentId":"fld_359735319ebc456d889005db31c915ed","settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingFollowRedirects":"global","settingRebuildPath":true,"settingSendCookies":true,"settingStoreCookies":true,"url":"{{ baseUrl }}/login","_type":"request"},{"_id":"fld_359735319ebc456d889005db31c915ed","created":1598562504855,"description":"","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1598562504855,"modified":1598562511308,"name":"Login","parentId":"wrk_1232ccd2368d4561bbcf65cd441b6cc7","_type":"request_group"},{"_id":"req_48693633d3774e8f84dd34bfa824e353","authentication":{"token":"{{ token }}","type":"bearer"},"body":{},"created":1598562041453,"description":"### Descrição\n\n> Este recurso retorna a quantidade de vítimas e ocorrências (independente da especificação dos mesmos) registradas em um dado ano ou todos os disponíveis na base.\n\n* __Parâmetros__\n\nO parâmetro _:ano_ recebe a identificação do ano, por exemplo **2020**. Caso demande a requisição para todos os anos presentes na base de dados, inserir **todos**.\n\n<!-- RESPONSE -->\n{\n\t“Ano” : 2018,\n\t“Vitimas” : 200\n\t“Ocorrencias”: 200\n}\n\n<!-- ENDRESPONSE -->\n","headers":[{"description":"","id":"pair_f391e8e2ab3e49cfa920b78690997451","name":"","value":""}],"isPrivate":false,"metaSortKey":-1598562041453,"method":"GET","modified":1598576579349,"name":"Quantidade de crimes por ano","parameters":[],"parentId":"fld_4cc46d0c06724d108cda0995831f0deb","settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingFollowRedirects":"global","settingRebuildPath":true,"settingSendCookies":true,"settingStoreCookies":true,"url":"{{ baseUrl }}/quantidade/crimes/:ano","_type":"request"},{"_id":"fld_4cc46d0c06724d108cda0995831f0deb","created":1598469374302,"description":"","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1598561439491,"modified":1598562195631,"name":"Quantidades","parentId":"wrk_1232ccd2368d4561bbcf65cd441b6cc7","_type":"request_group"},{"_id":"req_6604b52193024a22ace66e96f210fd64","authentication":{"token":"{{ token }}","type":"bearer"},"body":{},"created":1598463787511,"description":"### Descrição\n\n> Este recurso retorna a quantidade de crimes notificados em um determinado estado. \n\n* __Parâmetros__\n\nO parâmetro _:sigla_ recebe a identificação do estado, por exemplo **ceara** ou **ce**. Caso demande a requisição para os dados do país inteiro, inserir **bra** ou **brasil**.\n\nO parâmetro _:nomecrime_ recebe a especificação do crime, por exemplo **roubo_veiculo**. Caso demande a requisição para os dados de todos os crimes, inserir **todos**.\n\n\n<!-- RESPONSE -->\n{\n\t“quantidade_furto_de_veiculos ” : 200,\n\t“quantidade_roubo_instituicao_financeira”: 200,\n\t“quantidade_roubo_carga”: 200,\n“quantidade_roubo_veiculo”: 200, \n\t“quantidade_estupro” : 200,\n\t“quantidade_tentativa_homicidio” : 200\n}\n<!-- ENDRESPONSE -->","headers":[],"isPrivate":false,"metaSortKey":-1598469389063,"method":"GET","modified":1598641668498,"name":"Quantidade de ocorrências","parameters":[],"parentId":"fld_4cc46d0c06724d108cda0995831f0deb","settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingFollowRedirects":"global","settingRebuildPath":true,"settingSendCookies":true,"settingStoreCookies":true,"url":"{{ baseUrl }}/quantidade/ocorrencias/:nome/:sigla","_type":"request"},{"_id":"req_c1b08ebf49f64dec9506cc21f1740ee7","authentication":{"token":"{{ token }}","type":"bearer"},"body":{},"created":1598471352655,"description":"### Descrição\n\n> Este recurso retorna a quantidade de vítimas de um dado crime (ou todos os crimes da base) notificadas em um determinado estado (ou no país inteiro).  \n\n* __Parâmetros__\n\nO parâmetro _:sigla_ recebe a identificação do estado, por exemplo **ceara** ou **ce**. Caso demande a requisição para os dados do país inteiro, inserir **bra** ou **brasil**.\n\nO parâmetro _:nomecrime_ recebe a especificação do crime, por exemplo **homicidio_doloso**. Caso demande a requisição para os dados de todos os crimes, inserir **todos**.\n\n\n<!-- RESPONSE -->\n{\n\t“quantidade_homicidio_doloso ” : 200\n\t“quantidade_lesao_corporal_seguida_morte” : 200,\n\t“quantidade_latrocinio” : 200\n}\n\n<!-- ENDRESPONSE -->","headers":[],"isPrivate":false,"metaSortKey":-1598424942762,"method":"GET","modified":1598641657431,"name":"Quantidade de vítimas","parameters":[],"parentId":"fld_4cc46d0c06724d108cda0995831f0deb","settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingFollowRedirects":"global","settingRebuildPath":true,"settingSendCookies":true,"settingStoreCookies":true,"url":"{{ baseUrl }}/quantidade/vitimas/:nomedocrime/:sigla","_type":"request"},{"_id":"req_dda9a202f4094e3b904bb97e6e471482","authentication":{"token":"{{ token }}","type":"bearer"},"body":{},"created":1598471461822,"description":"### Descrição\n\n> Este recurso retorna a média mensal de ocorrências de um crime em determinado período de tempo.\n\n* __Parâmetros__\n\nO parâmetro _:sigla_ recebe a identificação do estado, por exemplo **ceara** ou **ce**. Caso demande a requisição para os dados do país inteiro, inserir **bra** ou **brasil**.\n\nO parâmetro _:nomecrime_ recebe a especificação do crime, por exemplo **roubo_veiculo**. Caso demande a requisição para os dados de todos os crimes, inserir **todos**.\n\nOs parâmetros _início_ e _fim_ recebem uma data de início e fim para o cálculo da média dentro daquele intervalo, por exemplo entre *jan-2020* e *mar-2020*.\n\n<!-- RESPONSE -->\n{\n\t“media_furto_de_veiculos ” : 200,\n\t“media_roubo_instituicao_financeira”: 200,\n\t“media_roubo_carga”: 200,\n“media_roubo_veiculo”: 200, \n\t“media_estupro” : 200,\n\t“media_tentativa_homicidio” : 200\n}\n\n<!-- ENDRESPONSE -->","headers":[],"isPrivate":false,"metaSortKey":-1598447165912.5,"method":"GET","modified":1598641181878,"name":"Média de ocorrências","parameters":[],"parentId":"fld_974a44ee09bf4cd2aa1194e0c049905e","settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingFollowRedirects":"global","settingRebuildPath":true,"settingSendCookies":true,"settingStoreCookies":true,"url":"{{ baseUrl }}/media/ocorrencias/:nomedocrime/:sigla/:inicio/:fim","_type":"request"},{"_id":"fld_974a44ee09bf4cd2aa1194e0c049905e","created":1598471451112,"description":"","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1598561439466,"modified":1598585297911,"name":"Médias","parentId":"wrk_1232ccd2368d4561bbcf65cd441b6cc7","_type":"request_group"},{"_id":"req_d3ae3435cc26422d95f123a9464ed469","authentication":{"token":"{{ token }}","type":"bearer"},"body":{},"created":1598471490228,"description":"### Descrição\n\n> Este recurso retorna a média mensal de vítimas de um crime em determinado período de tempo.\n\n* __Parâmetros__\n\nO parâmetro _:sigla_ recebe a identificação do estado, por exemplo **ceara** ou **ce**. Caso demande a requisição para os dados do país inteiro, inserir **bra** ou **brasil**.\n\nO parâmetro _:nomecrime_ recebe a especificação do crime, por exemplo **homicidio_doloso**. Caso demande a requisição para os dados de todos os crimes, inserir **todos**.\n\nOs parâmetros _início_ e _fim_ recebem uma data de início e fim para o cálculo da média dentro daquele intervalo, por exemplo entre *jan-2020* e *mar-2020*.\n\n<!-- RESPONSE -->\n{\n\t“media_homicidio_doloso ” : 200\n\t“media_lesao_corporal_seguida_morte” : 200,\n\t“media_latrocinio” : 200\n}\n<!-- ENDRESPONSE -->","headers":[],"isPrivate":false,"metaSortKey":-1598436054337.25,"method":"GET","modified":1598641288643,"name":"Média de vítimas","parameters":[],"parentId":"fld_974a44ee09bf4cd2aa1194e0c049905e","settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingFollowRedirects":"global","settingRebuildPath":true,"settingSendCookies":true,"settingStoreCookies":true,"url":"{{ baseUrl }}/media/vitimas/:nome/:sigla","_type":"request"},{"_id":"req_d8efedfc530e4bfd95c2078925fef572","authentication":{"token":"{{ token }}","type":"bearer"},"body":{},"created":1598561452406,"description":"### Descrição\n\n> Este recurso retorna o ranking de estados que apresentam uma maior ocorrência de determinado crime.\n\n* __Parâmetros__\n\nO parâmetro _:quantidade_ recebe um valor inteiro, por exemplo **10**. Determina a quantidade de elementos que devem aparecer no ranking. Caso demande a requisição para todos os estados, inserir **27**.\n\nO parâmetro _:nomecrime_ recebe a especificação do crime, por exemplo **roubo_veiculo**. Caso demande a requisição para os dados de todos os crimes, inserir **todos**.\n\n\n<!-- RESPONSE -->\n{\n\t“Crime” : ‘Roubo de veículo”\n\t“Ranking_estadual” : [‘CE’, ‘SP’, ‘RJ’]\n}\n\n<!-- ENDRESPONSE -->","headers":[],"isPrivate":false,"metaSortKey":-1598561452406,"method":"GET","modified":1598641614195,"name":"Ranking Estadual por Crime","parameters":[],"parentId":"fld_fc4393114eb74f16843bc9366f473ef1","settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingFollowRedirects":"global","settingRebuildPath":true,"settingSendCookies":true,"settingStoreCookies":true,"url":"{{ baseUrl }}/ranking/:quantidade/estadual/:nomedocrime","_type":"request"},{"_id":"fld_fc4393114eb74f16843bc9366f473ef1","created":1598561439441,"description":"","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1598561439441,"modified":1598561439441,"name":"Rankings","parentId":"wrk_1232ccd2368d4561bbcf65cd441b6cc7","_type":"request_group"},{"_id":"req_b452aab94b90424d8c4b48747798935f","authentication":{"token":"{{ token }}","type":"bearer"},"body":{},"created":1598561787155,"description":"### Descrição\n\n> Este recurso retorna o ranking de crimes que apresentam uma maior ocorrência em um dado estado (ou no país inteiro).\n\n* __Parâmetros__\n\nO parâmetro _:quantidade_ recebe um valor inteiro, por exemplo **10**. Determina a quantidade de elementos que devem aparecer no ranking. Caso demande a requisição para todos os crimes, inserir **todos**.\n\nO parâmetro _:sigla_ recebe a especificação do estado, por exemplo **ceara** ou **ce**.  Caso demande a requisição para os dados do país inteiro, inserir **bra** ou **brasil**.\n\n\n\n<!-- RESPONSE -->\n{\n\t“UF”: CE\n\t“Ranking_criminal”: [‘Roubo de veículo’, ‘Roubo de veículo’,‘Roubo de veículo’ ]\n}\n<!-- ENDRESPONSE -->","headers":[],"isPrivate":false,"metaSortKey":-1598549616358.5,"method":"GET","modified":1598576754356,"name":"Ranking Criminal por Estado","parameters":[],"parentId":"fld_fc4393114eb74f16843bc9366f473ef1","settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingFollowRedirects":"global","settingRebuildPath":true,"settingSendCookies":true,"settingStoreCookies":true,"url":"{{ baseUrl }}/ranking/:quantidade/criminal/:sigla","_type":"request"},{"_id":"env_a942f4ff24e31626c583e8cf7f0c3c00c62481d1","color":null,"created":1580836422528,"data":{"baseUrl":"www.api.com","token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MiwiaWF0IjoxNTk4NTYyNTYwLCJleHAiOjE1OTkxNjczNjB9.BC9zTwZs-WPm7K2oqaHaOXV3zDBqIXE0gqx0WDvovCM"},"dataPropertyOrder":{"&":["baseUrl","token"]},"isPrivate":false,"metaSortKey":1580836422528,"modified":1598562723972,"name":"Base Environment","parentId":"wrk_1232ccd2368d4561bbcf65cd441b6cc7","_type":"environment"},{"_id":"jar_a942f4ff24e31626c583e8cf7f0c3c00c62481d1","cookies":[],"created":1580836422536,"modified":1598563226949,"name":"Default Jar","parentId":"wrk_1232ccd2368d4561bbcf65cd441b6cc7","_type":"cookie_jar"},{"_id":"spc_8535df4f953c45c6aa6922d5e23e27b0","contentType":"yaml","contents":"","created":1591101223208,"fileName":"teste","modified":1591101223208,"parentId":"wrk_1232ccd2368d4561bbcf65cd441b6cc7","_type":"api_spec"}]}