NEXTfleet

API: Integração de dados de chamados dos veículos frota COM APROVAÇÃO COTAÇÃO via JSON

Especificações para implementação de API

VISÃO GERAL

Este documento tem como objetivo auxiliar na integração de dados para o NEXTfleet.

A comunicação entre os servidores é feita através do protocolo HTTP, utilizando a porta 443 (HTTPS).

Para o envio das informações é necessário criar um HTTP API json, utilizando o método POST e o enconding UTF-8.

O conteúdo do envio deve ser do tipo json (Javascript Object Notation) e o header da requisição deve conter a premissa Content-Type: application/json;charset=utf-8

DESCRIÇÃO DAS COLUNAS

Aqui está uma apresentação das colunas e suas características

Ordem Coluna	Coluna	Decrição	Obrigatório	Único	Tipo	Tamanho Mínimo	Tamanho Máximo
1	numero_chamado	Número do chamado Ex.: 99871	SIM	NÃO	TEXTO	1	10
2	numero_os	Número ordem serviço. Ex.: 845123	NÃO	NÃO	TEXTO	0	40
3	numero_cotacao	Número cotação	NÃO	NÃO	TEXTO	0	40
4	data_abertura_chamado	Data de abertura do chamado. Ex.: 01/01/2016	SIM	NÃO	TEXTO	10	10
5	hora_abertura_chamado	Hora de abertura do chamado. Ex.: 11:01 OU 11:01:22	SIM	NÃO	TEXTO	5	8
6	cnpj	Número de CNPJ ou CPF com máscara. Ex.: 00.000.000/0000-00 ou 000.000.000-00	NÃO	NÃO	TEXTO	14	18
7	placa	Placa (Ex.: BEE4224 ou BEE4R22)	SIM	NÃO	TEXTO	7	10
8	km_veiculo	Hodômetro do veículo	NÃO	NÃO	NÚMERO	0	10
9	motivo	Tipo chamado: 1-Manutenção Corretiva, 2-Manutenção Preventiva, 3-Troca Pneus, 4-Sinistro, 5-Ordem Serviço, 6-Manutenção Corretiva/Compra Peças, 7-Manutenção Corretiva/Desmobilização	SIM	NÃO	NÚMERO	1	1
10	status_chamado	Status do chamado: 1-Aberto 2-Em manutenção 3-Concluido 4-Cancelado 5-Aguardando Aprovação 6-OS Devolvido	SIM	NÃO	NÚMERO	1	1
11	status_cotacao	Status do cotação: 0-Aguardando cotação 1-Aguardando aprovação 2-Aprovado reembolso 3-Confirmado 4-Redefinir 5-Cancelado	SIM	NÃO	NÚMERO	1	1
12	status_agendamento	Status do agendamento: 1-Aguardando 2-Agendado 3-Reagendado 4-Concluído 5-Cancelado	NÃO	NÃO	NÚMERO	0	1
13	classificacao_da_solicitacao	Classificação da chamado: 1-Roubo/Furto 2-Perda Total 3-Arrombamento 4-Colisão 5-Outros	NÃO	NÃO	NÚMERO	0	1
14	houve_envolvimento_com_terceiro	Houve envolvimento de terceiros: 1-Sim 2-Não	NÃO	NÃO	NÚMERO	0	1
15	quantidade_veiculos_envolvidos	Quantidade de veículos envolvidos	NÃO	NÃO	NÚMERO	0	2
16	quem_causou_acidente	Quem causou o acidente: 1-Condutor Frota 2-Terceiro 3-Outros	NÃO	NÃO	NÚMERO	0	1
17	fornecedor	Fornecedor	NÃO	NÃO	TEXTO	0	255
18	contato_fornecedor	Contado do fornecedor	NÃO	NÃO	TEXTO	0	255
19	primeira_informacao_no_chamado	Primeira informação do chamado Ex.: Descrição inicial	NÃO	NÃO	TEXTO
20	data_agendamento_oficina	Data agendamento da oficina Ex.: 01/01/2016	NÃO	NÃO	TEXTO	0	10
21	hora_agendamento_oficina	Hora agendamento da oficina Ex.: 11:01 OU 11:01:22	NÃO	NÃO	TEXTO	5	8
22	data_entrada_oficina	Data de entrada na oficina Ex.: 01/01/2016	NÃO	NÃO	TEXTO	0	10
23	hora_entrada_oficina	Hora de entrada na oficina Ex.: 11:01 OU 11:01:22	NÃO	NÃO	TEXTO	5	8
24	data_chegada_orcamento	Data de chegada do orçamento Ex.: 01/01/2016	NÃO	NÃO	TEXTO	0	10
25	hora_chegada_orcamento	Hora de chegada do orçamento Ex.: 11:01 OU 11:01:22	NÃO	NÃO	TEXTO	5	8
26	data_aprovacao_orcamento	Data aprovação do orçamento Ex.: 01/01/2016	NÃO	NÃO	TEXTO	0	10
27	hora_aprovacao_orcamento	Hora aprovação do orçamento Ex.: 11:01 OU 11:01:22	NÃO	NÃO	TEXTO	5	8
28	data_previsao_entrega	Data de previsão de entrega Ex.: 01/01/2016	NÃO	NÃO	TEXTO	0	10
29	hora_previsao_entrega	Hora de previsão de entrega Ex.: 11:01 OU 11:01:22	NÃO	NÃO	TEXTO	5	8
30	data_conclusao_servico	Data conclusão do serviço Ex.: 01/01/2016	NÃO	NÃO	TEXTO	0	10
31	hora_conclusao_servico	Hora conclusão do serviço Ex.: 11:01 OU 11:01:22	NÃO	NÃO	TEXTO	5	8
32	data_retirada_veiculo_oficina	Data retirada do veículo da oficina Ex.: 01/01/2016	NÃO	NÃO	TEXTO	0	10
33	hora_retirada_veiculo_oficina	Hora retirada do veículo da oficina Ex.: 11:01 OU 11:01:22	NÃO	NÃO	TEXTO	5	8
34	numero_rca	Número RCA	NÃO	NÃO	TEXTO	0	30
35	valor_os	Valor da total a ordem de serviço. Ex.: R$ 1.001,01	NÃO	NÃO	TEXTO	0	20
36	valor_reembolsado	Valor do reembolso, caso franquia. Ex.: R$ 1.001,01	NÃO	NÃO	TEXTO	0	20
37	data_retirada_veiculo_reserva	Data de retirada do veículo reserva. Ex.: 01/01/2016	NÃO	NÃO	TEXTO	0	10
38	hora_retirada_veiculo_reserva	Hora de retirada do veículo reserva. Ex.: 11:01 OU 11:01:22	NÃO	NÃO	TEXTO	5	8
39	data_devolucao_veiculo_reserva	Data de devolução do veículo reserva. Ex.: 01/01/2016	NÃO	NÃO	TEXTO	0	10
40	hora_devolucao_veiculo_reserva	Hora de devolução do veículo reserva. Ex.: 11:01 OU 11:01:22	NÃO	NÃO	TEXTO	5	8
41	valor_diarias	Valor da diária. Ex.: R$ 1.001,01	NÃO	NÃO	TEXTO	0	20
42	valor_adicional_reserva	Valor adicional da reserva. Ex.: R$ 1.001,01	NÃO	NÃO	TEXTO	0	20
43	descricao_despesa_veiculo_reserva	Descrição das despesas do veículo reserva	NÃO	NÃO	TEXTO
44	quantidade_pneus_trocados	Quantidade de pneus trocados Ex.: 2	NÃO	NÃO	NÚMERO	0	1
45	valor_franquia	Valor do reembolso, caso franquia. Ex.: R$ 1.001,01	NÃO	NÃO	TEXTO	0	20
46	responsavel_locadora	Nome responsável interno locadora	NÃO	NÃO	TEXTO	0	255

FORMATO DO CONTEÚDO

O json está dividido em duas chaves, sendo elas: hash e data

hash: Este hash será fornecido pela Plantech, afim de indentificar o solicitante da transação.
data: A chave data é onde estará as informações para integração, ela é composta de um json com multiplas linhas e para cada linha existe chaves e valores, as chaves não podem ser modificadas, apenas os valores pedem ser modificados.

Observação: O json que será enviado não necessita ter indentação e espaços em branco entre suas linhas e chaves.

Para teste recomentamos a utilização da ferramenta do Google Advanced REST client

URL PARA TRANSFERÊNCIA

https://sisint.nextfleet.online/publicf/integracao/json/chamado_aprovacao.php

Necessário protocolo TLS 1.2

EXEMPLO JSON

{
    "hash" : "xxxxxxxxxxxxxxxx",
    "data" :
    [
        {
            "numero_chamado" : "99871",
            "numero_os" : "84512",
            "numero_cotacao" : "46788",
            "data_abertura_chamado" : "01/12/2016",
            "hora_abertura_chamado" : "11:25",
            "cnpj" : "00.000.000/0000-00",
            "placa" : "QQQ9999",
            "km_veiculo" : "110000",
            "motivo" : "4",
            "status_chamado" : "1",
            "status_cotacao" : "0",
            "status_agendamento" : "1",
            "classificacao_da_solicitacao" : "4",
            "houve_envolvimento_com_terceiro" : "1",
            "quantidade_veiculos_envolvidos" : "2",
            "quem_causou_acidente" : "1",
            "fornecedor" : "EMPRESA EXEMPLO S.A.",
            "contato_fornecedor" : "55 11 00000000",
            "primeira_informacao_no_chamado" : "Condutor estava trafegando e colidiu seu veiculo",
            "data_agendamento_oficina" : "01/12/2016",
            "hora_agendamento_oficina" : "11:11",
            "data_entrada_oficina" : "01/12/2016",
            "hora_entrada_oficina" : "11:11",
            "data_chegada_orcamento" : "01/12/2016",
            "hora_chegada_orcamento" : "11:11",
            "data_aprovacao_orcamento" : "01/12/2016",
            "hora_aprovacao_orcamento" : "11:11",
            "data_previsao_entrega" : "01/12/2016",
            "hora_previsao_entrega" : "11:11",
            "data_conclusao_servico" : "01/12/2016",
            "hora_conclusao_servico" : "11:11",
            "data_retirada_veiculo_oficina" : "01/12/2016",
            "hora_retirada_veiculo_oficina" : "11:11",
            "numero_rca" : "000000",
            "valor_os" : "R$ 1.502,87",
            "valor_reembolsado" : "R$ 0,01",
            "data_retirada_veiculo_reserva" : "01/12/2016",
            "hora_retirada_veiculo_reserva" : "11:11",
            "data_devolucao_veiculo_reserva" : "01/12/2016",
            "hora_devolucao_veiculo_reserva" : "11:11",
            "valor_diarias" : "R$ 91,12",
            "valor_adicional_reserva" : "R$ 0,11",
            "descricao_despesa_veiculo_reserva" : "REPASSE REF A COMBUSTÍVEL",
            "quantidade_pneus_trocados" : "1",
			"valor_franquia" : "R$ 0,01",
            "responsavel_locadora" : "JORGE DA SILVEIRA"
      	}
    ]
}

RETORNO DA REQUISIÇÃO

O retorno da transação ocorre no formato json, sendo possível dois tipos de retorno: sucesso ou erro

Sucesso: O sucesso ocorre quando a transação foi efetuada sem ocorrências. E seu formato é o seguinte:
```
{"ok":1}
```
Erro: O erro ocorre quando a transação não foi efetuada devido ao o número de colunas serem incompatíveis, inconsistência nas informaçõe, erro interno no servidor, entre outos. E seu formato é o seguinte:
```
{"ok":0,"error":["Erro 1","Erro 2"]}
```
No formato real os error estaram detalhados para melhor entendimento de ambas as partes interessadas.