0.1.1 • Published 8 months ago

api-multas v0.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

💵 API de Multas Brasil

A ideia desse repositório é obter dados de Multas de todos os Detrans, através de Web Scrap e retornar os dados das multas em JSON

Estados suportados

Ainda não suportamos todos os estados, em breve iremos adicionar mais estados, se quiser sugerir um estado, abra uma PR

Servidor Back-end

Você irá precisar subir um servidor Backend para consumir esse pacote

https://github.com/APIBrasil/api-multas

Ou de um servidor de API

https://apibrasil.io

Estados suportados

Ainda não suportamos todos os estados, em breve iremos adicionar mais estados, se quiser sugerir um estado, abra uma PR

DETRANSITUAÇÃODISPONIBILIDADEOBSERVAÇÕES
Detran MGDISPONÍVELOperacional
Detran ALDISPONÍVELOperacional
Detran PBDISPONÍVELOperacional
Detran GODISPONÍVELOperacional
Detran MADISPONÍVELOperacional
Detran DFDISPONÍVELOperacional
Detran MSDISPONÍVELOperacional
Detran PEDISPONÍVELOperacional
Detran SEDISPONÍVELOperacional
Detran PRDISPONÍVELOperacional
Detran PIDISPONÍVELOperacionalNecessário informar webhook
Detran PADISPONÍVELOperacionalNecessário informar webhook
Detran ACEm desenvolvimento
Detran AMEm desenvolvimento
Detran BAEm desenvolvimento
Detran CEEm desenvolvimento
Detran ESEm desenvolvimento
Detran MTEm desenvolvimento
Detran RJEm desenvolvimento
Detran RNEm desenvolvimento
Detran ROEm desenvolvimento
Detran RREm desenvolvimento
Detran RSEm desenvolvimento
Detran SCEm desenvolvimento
Detran SPEm desenvolvimento
Detran TOEm desenvolvimento

Como instalar usando npm

npm i api-multas

Como instalar usando yarn

yarn add api-multas

Como consumir com TypeScript

import ApiMultas from 'api-multas'

(async () => {

    const host = 'http://localhost:2222';
    const token = '1234567890';

    const api = new ApiMultas();

    const request = await api.multas('mg', host, token, {
        placa: 'ABC1234',
        renavam: '0000000000'
    });

    console.log(request);

})();

Oservações para o estado de PI, que por ter captcha é necessário obter uma chave do 2captcha

import ApiMultas from 'api-multas'

(async () => {

    const host = 'http://localhost:2222';
    const token = '1234567890';

    const api = new ApiMultas();

    //use o webhook.site para visualizar o retorno
    const request = await api.multas('mg', host, token, {
        placa: "ABC1234",
        renavam: "0000000000",
        twocaptchaapikey: "abc1234abc1234abc1234abc1234",
        webhook: "https://webhook.site/3545dc20-14ff-4c74-bee0-755762fd834a"
    });

    console.log(request);

})();

Possiveis respostas

{
    "placa": "ABC1234",
    "renavam": "00000000000",
    "multas": [
        {
            "sequencia": "1",
            "processo": "00000000",
            "descricao": "TRANSITAR EM VELOCIDADE SUPERIOR A MAXIMA PERMITIDA EM ATE 2",
            "local": "AV. RISOLETA NEVES  A 138M DA RUA RAIMUNDA FERREIR",
            "valor": 152.11
        },
        {
            "sequencia": "2",
            "processo": "00000000",
            "descricao": "DIRIGIR VEICULO SEGURANDO TELEFONE CELULAR",
            "local": "AVE AFONSO SILVA ESQUINA RUA ESPIRITO DE LUZ",
            "valor": 299.54
        }
    ]
}

Observações

⚠️ Essa API é apenas parte de um estudo pessoal, use em produção por sua conta e risco, lembre-se essa API se basea em técnicas de web scrap para obter os dados em transformar em JSON, se o DETRAN do seu estado alterar algo nos avise para que possamos corrgir.

0.1.1

8 months ago

0.1.0

8 months ago

0.0.9

8 months ago

0.0.8

8 months ago

0.0.7

8 months ago

0.0.6

8 months ago

0.0.5

8 months ago

0.0.4

8 months ago

0.0.3

8 months ago

0.0.2

8 months ago

0.0.1

8 months ago