andrevvalle / sinesp-api

Módulo do Node.js que permite a consulta de placa no território nacional utilizando a base de dados do Sistema Nacional de Informações de Segurança Pública (SINESP).

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

sinesp-api

NPM version Build Status Coverage Status Dependency Status devDependency Status Greenkeeper badge

PagSeguro PayPal
Doe com PagSeguro - é rápido, grátis e seguro! Make a donation

Módulo do Node.js que permite a consulta de placa no território nacional utilizando a base de dados do Sistema Nacional de Informações de Segurança Pública (SINESP).

Instalação

$ npm install sinesp-api --save

API

search(plate)Promise.<object>

Busca o veículo pela placa

configure([host], [endpoint], [serviceVersion], [androidVersion], [proxy])

Configura o módulo

search(plate) ⇒ Promise.<object>

Busca o veículo pela placa

Retorna: Promise.<object> - A representação do veículo identificado pela placa

Parâmetro Tipo Descrição
plate string A placa do veículo a ser consultada

Example

let vehicle = await search('AAA111');

Saída

{
    "codigoRetorno":                         "0",
    "mensagemRetorno":                       "Sem erros.",
    "codigoSituacao":                        "0",
    "situacao":                              "Sem restrição",
    "modelo":                                "FIAT/UNO MILLE EP",
    "marca":                                 "FIAT/UNO MILLE EP",
    "cor":                                   "BRANCA",
    "ano":                                   "1996",
    "anoModelo":                             "1996",
    "placa":                                 "ABC1234",
    "data":                                  "02/08/2018 às 02:52:34",
    "uf":                                    "DF",
    "municipio":                             "BRASILIA",
    "chassi":                                "99092",
    "dataAtualizacaoCaracteristicasVeiculo": "13/04/2018",
    "dataAtualizacaoRouboFurto":             "01/08/2018",
    "dataAtualizacaoAlarme":                 "01/08/2018"
}

configure([host], [endpoint], [serviceVersion], [androidVersion], [proxy]) ⇒

Configura o módulo

Retorna: O próprio módulo

Parâmetro Tipo Default Descrição
[host] string "cidadao.sinesp.gov.br" Host do serviço SINESP
[endpoint] string "/sinesp-cidadao/mobile/consultar-placa/" Endpoint do serviço SINESP
[serviceVersion] string "v4" Versão do serviço SINESP
[androidVersion] string "8.1.0" Versão do Android a ser informada para o serviço SINESP
[secret] string "g8LzUadkEHs7mbRqbX5l" A chave usada para encriptar a placa
[timeout] number 0 req/res timeout em ms, reseta ao seguir redirecionamentos. 0 para desabilitar (Limite do SO aplicado)
[maximumRetry] number 0 Número máximo de tentativas se a requisição falhar
[proxy] object {} O objeto com configurações de proxy, caso exista

Atenção

Esta implementação não possui nenhum vínculo oficial com o Sistema Nacional de Informações de Segurança Pública (SINESP). Não há garantias de funcionamento após atualizações da API.

About

Módulo do Node.js que permite a consulta de placa no território nacional utilizando a base de dados do Sistema Nacional de Informações de Segurança Pública (SINESP).

License:MIT License


Languages

Language:JavaScript 100.0%