Promise.<object>Busca o veículo pela placa
49 |Configura o módulo
52 |Promise.<object>
56 | Busca o veículo pela placa
57 |
58 | **Retorna**: Promise.<object> - A representação do veículo identificado pela placa
59 |
60 | | Parâmetro | Tipo | Descrição |
61 | | --- | --- | --- |
62 | | plate | string | A placa do veículo a ser consultada |
63 |
64 | **Exemplo**
65 | ```js
66 | const sinespApi = require('sinesp-api');
67 |
68 | let vehicle = await sinespApi.search('AAA111');
69 | ```
70 |
71 | ### Saída
72 |
73 | ```json
74 | {
75 | "codigoRetorno": "0",
76 | "mensagemRetorno": "Sem erros.",
77 | "codigoSituacao": "0",
78 | "situacao": "Sem restrição",
79 | "modelo": "FIAT/UNO MILLE EP",
80 | "marca": "FIAT/UNO MILLE EP",
81 | "cor": "BRANCA",
82 | "ano": "1996",
83 | "anoModelo": "1996",
84 | "placa": "ABC1234",
85 | "data": "02/08/2018 às 02:52:34",
86 | "uf": "DF",
87 | "municipio": "BRASILIA",
88 | "chassi": "99092",
89 | "dataAtualizacaoCaracteristicasVeiculo": "13/04/2018",
90 | "dataAtualizacaoRouboFurto": "01/08/2018",
91 | "dataAtualizacaoAlarme": "01/08/2018"
92 | }
93 | ```
94 |
95 |
96 |
97 | ## configure([host], [endpoint], [serviceVersion], [timeout], [maximumRetry], [proxy]) ⇒
98 | Configura o módulo
99 |
100 | **Retorna**: O próprio módulo
101 |
102 | | Parâmetro | Tipo | Default | Descrição |
103 | | --- | --- | --- | --- |
104 | | [host] | string | "apicarros.com" | Host do serviço SINESP |
105 | | [endpoint] | string | "consulta" | Endpoint do serviço SINESP |
106 | | [serviceVersion] | string | "v1" | Versão do serviço SINESP |
107 | | [timeout] | number | 0 | req/res timeout em ms, reseta ao seguir redirecionamentos. 0 para desabilitar (Limite do SO aplicado) |
108 | | [maximumRetry] | number | 0 | Número máximo de tentativas se a requisição falhar |
109 | | [proxy] | object | {} | O objeto com configurações de proxy, caso exista |
110 |
111 | ---
112 |
113 | ## Atenção
114 |
115 | 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](https://github.com/100n0m3/API-Carros) para a obtenção dos dados e deixamos aqui nosso agradecimento pela disponilização do serviço.
116 |
--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
1 | /**
2 | * @file Manages the wrapper of SINESP's search for plates
3 | *
4 | * @author Lucas Bernardo
5 | */
6 |
7 | const { retry } = require('./tools');
8 |
9 | /**
10 | * The accepted format: AAA0000, AAA0AA0, AAA00A0
11 | *
12 | * @constant
13 | *
14 | * @type {RegExp}
15 | */
16 | const PLATE_FORMATS = [
17 | /^[a-zA-Z]{3}[0-9]{4}$/im,
18 | /^[a-zA-Z]{3}[0-9]{1}[a-zA-Z]{1}[0-9]{2}$/im,
19 | /^[a-zA-Z]{3}[0-9]{2}[a-zA-Z]{1}[0-9]{1}$/im,
20 | ];
21 | const SPECIAL = /[^a-zA-Z0-9]/i;
22 |
23 | const DEFAULT = {
24 | host: 'apicarros.com',
25 | endpoint: 'consulta',
26 | serviceVersion: 'v1',
27 | timeout: 0,
28 | maximumRetry: 0,
29 | proxy: {},
30 | };
31 |
32 | let opts = {};
33 |
34 | /**
35 | * Validate the format of the plate informed
36 | *
37 | * @param {string} plate - The informed plate
38 | *
39 | * @returns {Promise