3.0.0 • Published 3 years ago

sinesp-api v3.0.0

Weekly downloads
314
License
MIT
Repository
github
Last release
3 years ago

sinesp-api

NPM version Build Status Coverage Status Dependency Status devDependency Status snyk badge node badge

PagSeguroPayPal
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 da API-Carros.

Pré-requisitos

  • Versões do Node.js anteriores a 8 não são compatíveis;

Instalação

$ npm install sinesp-api --save

API

search(plate) ⇒ Promise.<object>

Busca o veículo pela placa

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

ParâmetroTipoDescrição
platestringA placa do veículo a ser consultada

Exemplo

const sinespApi = require('sinesp-api');

let vehicle = await sinespApi.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, timeout, maximumRetry, proxy) ⇒

Configura o módulo

Retorna: O próprio módulo

ParâmetroTipoDefaultDescrição
hoststring"apicarros.com"Host do serviço SINESP
endpointstring"consulta"Endpoint do serviço SINESP
serviceVersionstring"v1"Versão do serviço SINESP
timeoutnumber0req/res timeout em ms, reseta ao seguir redirecionamentos. 0 para desabilitar (Limite do SO aplicado)
maximumRetrynumber0Número máximo de tentativas se a requisição falhar
proxyobject{}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). Utilizamos a API-Carros para a obtenção dos dados e deixamos aqui nosso agradecimento pela disponilização do serviço.

3.0.0

3 years ago

2.0.4

3 years ago

2.0.3

3 years ago

2.0.2

4 years ago

2.0.1

4 years ago

1.5.3

5 years ago

1.5.2

5 years ago

1.5.1

5 years ago

1.5.0

5 years ago

1.4.0

5 years ago

1.3.15

5 years ago

1.2.15

5 years ago

1.2.14

5 years ago

1.2.13

5 years ago

1.2.12

5 years ago

1.2.10

5 years ago

1.2.9

5 years ago

1.2.8

5 years ago

1.2.7

6 years ago

1.2.6

6 years ago

1.2.5

6 years ago

1.2.4

6 years ago

1.2.2

6 years ago

1.2.1

6 years ago

1.2.0

6 years ago

1.1.0

6 years ago

1.0.9

6 years ago

1.0.8

6 years ago

1.0.7

6 years ago

1.0.6

6 years ago

1.0.5

6 years ago

1.0.4

6 years ago

1.0.3

6 years ago

1.0.2

6 years ago

1.0.1

6 years ago

1.0.0

6 years ago