A documentação foi deita usando o software Insomnia Code.
Através do Netlify a documentação e outros dados podem ser acessados através desse link:
Segue uma breve parte da documentação, para acessa-lá completa uso o link indicado anteriormente.
A 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.
A 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.
Para conectar-se a API precisará primeiro autenticar-se com:
- Senha Na rota /login, que retornará um:
- Token
Usamos o jwt token como forma de autenticação. Ele deve ser passado como cabeçalho (Header) nas rotas protegidas que necessitam obrigatoriamente dele. O 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. Mais informações sobre o JSON Web Token poderão ser encontradas no site jsonwebtoken.io.
Todos os recursos suportam o envio de respostas no formato JSON. Para obter a resposta basta enviar uma requisição HTTP.
Abaixo estão listados os recursos disponivéis pela API.
Recurso responsável por cadastrar e inserir um usuário no banco de dados.
Recurso responsável por logar o usuário no sistema e retorná-lo o token de acesso.
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.
- Parâmetros
O 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.
Este recurso retorna a quantidade de crimes notificados em um determinado estado.
- Parâmetros
O 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.
O 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.
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).
- Parâmetros
O 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.
O 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.
Este recurso retorna a média mensal de ocorrências de um crime em determinado período de tempo.
- Parâmetros
O 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.
O 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.
Os parâmetros início e fim recebem uma data de início e fim para o cálculo da média dentro daquele intervalo.
Este recurso retorna a média mensal de vítimas de um crime em determinado período de tempo.
- Parâmetros
O 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.
O 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.
Os parâmetros início e fim recebem uma data de início e fim para o cálculo da média dentro daquele intervalo.
Este recurso retorna o ranking de estados que apresentam uma maior ocorrência de determinado crime.
- Parâmetros
O 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.
O 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.
Este recurso retorna o ranking de crimes que apresentam uma maior ocorrência em um dado estado (ou no país inteiro).
- Parâmetros
O 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.
O 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.