sinesp-api

| PagSeguro | PayPal | | :-------------: | :-------------: | |

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âmetro | Tipo | Descrição | | --- | --- | --- | | plate | string | A 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âmetro | Tipo | Default | Descrição | | --- | --- | --- | --- | | [host] | string | "apicarros.com" | Host do serviço SINESP | | [endpoint] | string | "consulta" | Endpoint do serviço SINESP | | [serviceVersion] | string | "v1" | Versão do serviço SINESP | | [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). Utilizamos a API-Carros para a obtenção dos dados e deixamos aqui nosso agradecimento pela disponilização do serviço.