Simova NFS API: Apresentação

Simova NFS API
Elaborado por Alan Mocellin em 04/01/2021
Apresentação
O NFS permite a comunicação por API através de uma API usando JWT (Json Web Token).
A fim de consumo de dados, nossos clientes vão poder criar as suas próprias ferramentas de BI ou
consulta interna com base nas API’s.
Tabelas
Sincronismo
CLIENTE
Tabela de cliente
Campo Tipo de dados Descrição
DESCRICAO VARCHAR(250) Descrição do cliente
LOJA VARCHAR(20) Loja do cliente
ENDERECO VARCHAR(250) Endereço do cliente
MUNICIPIO VARCHAR(250) Município do cliente
CODIGOCLIENTE VARCHAR(20) Código do cliente
TELEFONE VARCHAR(100) Telefone do cliente
IDENTIFICACAO VARCHAR(100) Identificação do cliente
ATIVO VARCHAR(10) Cliente ativo Sim-1/Não-0
CELULAR VARCHAR(100) Celular do cliente
INSCRICAOESTADUAL VARCHAR(100) Inscrição estadual do cliente
BAIRRO VARCHAR(100) Bairro do cliente
CEP VARCHAR(100) CEP do cliente
EMAIL VARCHAR(100) E-mail do cliente
CNPJCPF VARCHAR(20) CNPJ ou CPF do cliente
NROPROPRIETARIO VARCHAR(50) Número do proprietário (endereço)
-1-
TIPO EQUIPAMENTO
Tabela de tipo do equipamento
DESCRICAO VARCHAR(250) Descrição do tipo de equipamento
CODIGOTIPOEQUIPAMENTO VARCHAR(20) Código do tipo de equipamento
ATIVO VARCHAR(10) Tipo equip ativo

1-Sim;0-Não
MODELO EQUIPAMENTO
Tabela de modelo do equipamento
DESCRICAO VARCHAR(250) Descrição do modelo equipamento

CODIGOMODELOEQUIPAMENTO VARCHAR(20) Código do modelo equipamento
SEQTIPOEQUIPAMENTO VARCHAR(100) Sequencial do tipo equipamento
ATIVO VARCHAR(10) Modelo equip ativo

1-Sim;0-Não
MODELO VARCHAR(100) Modelo do equipamento
EQUIPAMENTO
Tabela de equipamento
DESCRICAO VARCHAR(250) Descrição do equipamento
CODIGOEQUIPAMENTO VARCHAR(20) Código do equipamento
CHASSI VARCHAR(100) Chassi do equipamento
SEQCLIENTE VARCHAR(100) Sequencial do cliente (interno)
ATIVO VARCHAR(10) Equipamento ativo

1-Sim;0-Não
MODELO VARCHAR(100) Modelo do equipamento
SEQMODELOEQUIPAMENTO VARCHAR(100) Sequencial do modelo do equip.
MEDICAO
Tabela de medição horímetro/odômetro
SEQEQUIPAMENTO VARCHAR(100) Sequencial do equipamento
MEDICAO DECIMAL(7.1) Medição do horímetro/odômetro
-2-
ATIVO VARCHAR(10) Medição ativa
1-Sim;0-Não
PRODUTO
Tabela de produto
DESCRICAO VARCHAR(250) Descrição do produto
CODIGOPRODUTO VARCHAR(50) Código do produto
SEQUNIMADEMEDIDA VARCHAR(100) Sequencial da unidade de medida:

1-Litro;2-Unidade
ATIVO VARCHAR(10) produto ativo

1-Sim;0-Não
SERVICO
Tabela de serviço
DESCRICAO VARCHAR(250) Descrição do serviço
CODIGOSERVICO VARCHAR(20) Código do serviço
TEMPOPADRAO VARCHAR(100) Tempo padrão do serviço
SEQGRUPOSERVICO VARCHAR(100) Sequencial do grupo serviço:

1-Mão de obra
ATIVO VARCHAR(10) Equipamento ativo

1-Sim;0-Não
PLANO MANUTENCAO
Tabela de plano de manutenção
DESCRICAO VARCHAR(250) Descrição do plano de manutenção
SEQMODELOEQUIPAMENTO VARCHAR(20) Sequencial do modelo de

equipamento
MEDICAOMINIMO VARCHAR(100) Medição mínima do plano de

manutenção
MEDICAOMAXIMO VARCHAR(100) Medição máxima do plano de

manutenção
OBSERVACAO Observação do plano de manutenção
-3-
ATIVO VARCHAR(10) Plano de manutenção ativo
1-Sim;0-Não
PLANO MANUTENCAO DO PRODUTO

Tabela de plano de manutenção do produto
SEQPLANOMANUTENCAO VARCHAR(250) Sequencial do plano de manutenção
SEQPRODUTO VARCHAR(20) Sequencial do produto
QUANTIDADE VARCHAR(100) Quantidade do plano de manutenção

do produto
ATIVO VARCHAR(10) Plano de manutenção do produto

ativo
1-Sim;0-Não
PLANO MANUTENCAO DO SERVICO

Tabela de plano de manutenção do serviço
SEQPLANOMANUTENCAO VARCHAR(250) Sequencial do plano de manutenção
SEQSERVICO VARCHAR(20) Sequencial do serviço
TEMPOPADRAO VARCHAR(100) Tempo padrão do plano de

manutenção do serviço
ATIVO VARCHAR(10) Plano de manutenção do serviço ativo

1-Sim;0-Não
PECA
Tabela de peças
DESCRICAO VARCHAR(250) Descrição da peça
CODIGOPECA VARCHAR(20) Código da peça
ATIVO VARCHAR(10) Peça ativa

1-Sim;0-Não
OS
Tabela de ordem de serviços
FILIALOS VARCHAR(100) Filial da OS
-4-
LOCALOS VARCHAR(100) Local da OS = Filial OS
ATIVO VARCHAR(10) OS ativa:

1-Sim;0-Não
CODIGOOS INT(11) Número da OS
OBSERVACAO TEXT Observação da OS
DATAABERTURA TIMESTAMP Data de abertura da OS
STATUSOS VARCHAR(100) Sequencial do status da OS:

1-Aberto;5-Faturada;6-Cancelada;10-
Pré OS
TIPOOS VARCHAR(100) Sequencial do tipo de OS:

1-adicional;2-Programada;3-Garantia/
Cortesia;4-PMP;5-Marketing;6-Interno;
7-Retrabalho;8-Spot;9-Não definido no
ERP
TIPOATENDIMENTO VARCHAR(100) Sequencial do tipo de atendimento:

1-Normal;2-Retrabalho;3-JohnDeere;4
-Interno
SEQCLIENTE VARCHAR(100) Sequencial código do cliente
SEQEQUIPAMENTO VARCHAR(250) Sequencial do equipamento
OSxSERVICOS
Tabela de relacionamento de OS com serviços
SEQCODIGOOS VARCHAR(20) Sequencial da OS
SEQCODIGOSERVICO VARCHAR(20) Sequencial do Serviço
TEMPOPADRAO VARCHAR(100) Tempo padrão do serviço
CODIGOOSCAPA VARCHAR(10) Código da Capa da OS
NROITEM VARCHAR(10) Número do item
OSxTECNICO
Tabela de relacionamento de OS com técnicos
SEQCODIGOFUNCIONARIO VARCHAR(20) Sequencial do Funcionário
-5-
STATUSOS VARCHAR(10) Sequencial do status da OS:
1-Aberto;5-Faturada;6-Cancelada;10-
Pré OS
OSxPECAS
Tabela de relacionamento de OS com peças
SEQCODIGOPECA VARCHAR(20) Sequencial da peça
QTDREQUISITADA INT(10) Quantidade requisitada de peça na OS
-6-
API - WebServices
Autenticação
A primeira etapa é a autenticação por um método POST para isso o usuário deve existir cadastrado
dentro do NFS, com isso é enviado usuário e senha, o retorno é um token que vai expirar em 15 minutos, se
antes desse tempo autenticar novamente é gerado um novo token, o antigo para de funcionar e também tem
o tempo 15 minutos.
A url será o domínio do cliente mais /nfs/api/v1/auth, supondo que o domínio seja
slcagricola.h.simova.cloud, no final a chamada será:
https://slcagricola.h.simova.cloud/nfs/api/v1/auth
Parâmetros
Os parâmetros para autenticação são enviados como um Json Object [ 1] de acordo com a tabela 1.
Chave Obrigatório Descrição
user Sim E-mail válido do usuário

cadastrado no NFS
password Sim Password do usuário
empresa Sim Filial

Tabela 1
-7-
Requisições e Respostas
Request
curl --request POST

--url https://slcagricola.h.simova.cloud/nfs/api/v1/auth
--header 'content-type: application/json' \
--data '{
"user":"simova@simova.com.br",
"password":"Simova123",
"empresa":"Comercial"
}'
Response
{
"type": "success",
"msg": "Token gerado com sucesso.",
"token":
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJsaW54LWRtcy5oLnNpbW92YS5jbG91ZCIsIm
5hbWUiOiJzaW1vdmFAc2ltb3ZhLmNvbS5iciIsImVtYWlsIjoic2ltb3ZhQHNpbW92YS5jb20uYnIiLCJma
WxpYWwiOiJDb21lcmNpYWwiLCJsb2NhbCI6bnVsbCwiZXhwIjoiMjAyMS0wMS0wNCAxMzo0Njo0NyJ
9.5Zzl1i5rEvu6al\/1C9lo4XcrvcDB8U0rA\/6PjzmzVzE=",
"user": "simova@simova.com.br"
}
A chave token será usada no restante dos sincronismo e integração de dados.
-8-
Sincronismo
No sincronismo todas as chamadas são feitas por meio do método POST e no corpo é enviado um
Json Array [ 2].
O token sempre é enviado no header.
Entidades para sincronismo
Cliente
No cadastro de cliente será necessário fazer um POST no url:

https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/cliente. Assim um request realizado pelos campos da tabela
será necessários. Segue o modelo de resultado:
Request
curl --request POST \

--url: https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/cliente
--header 'authorization:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJsaW54LWRtcy5oLnNpbW92YS5jbG91ZCIsIm5
hbWUiOiJzaW1vdmFAc2ltb3ZhLmNvbS5iciIsImVtYWlsIjoic2ltb3ZhQHNpbW92YS5jb20uYnIiLCJmaW
xpYWwiOiJDb21lcmNpYWwiLCJsb2NhbCI6bnVsbCwiZXhwIjoiMjAyMS0wMS0wNCAxMzo0Njo0NyJ9.
5Zzl1i5rEvu6al\/1C9lo4XcrvcDB8U0rA\/6PjzmzVzE=' \
--[
{
"Descricao": "LUCAS DE LACERDA RIBEIRO",
-9-
"Loja": "MATRIZ",
"Endereco": "FAZENDA NOVA ESPERANCA - SN",
"Municipio": "RESERVA",
"CodigoCliente": "08402081975",
"Telefone": "",
"Identificacao": "084.020.819-75",
"Celular": "42-99949.0264",
"Ativo": "1",
"InscricaoEstadual": "95669352-76",
"Bairro": "ZONA RURAL",
"CEP": "84.320-000",
"Email": "",
"CNPJCPF": "10181621940",
"NroProprietario": "10181621940101"
}
]
Response
[
{
"type": "success",
"msg": "Cadastro de Cliente inserido com sucesso",
"field": "",
"id": "675"
}
]
Com essas informações o cadastro de cliente será inserido no nosso banco de dados e sua consulta
poderá ser realizada via painel Simova pelo endereço “https://slcagricola.h.simova.cloud/”. O ID gerado é um
sequencial interno que é usado em outras operações.
- 10 -
Tipo Equipamento
No cadastro de tipo de equipamento será necessário fazer um POST no url:

https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/tipo_equipamento. A
ssim, um request realizado pelos
campos da tabela será necessário. Segue o modelo de resultado:
Request

--url: https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/tipo_equipamento
--[
{
"CodigoEmpresa": "Comercial",
"Descricao": "AUTOMACAO DA MAQUINA",
"CodigoTipoEquipamento": "AUT",
"Ativo": "1"
}
]
Response
[
{
"type": "success",
"msg": "Cadastro de tipo equipamento inserido com sucesso",
"field": "",
"id": "12"
}
]
Com essas informações o cadastro de tipo do equipamento será inserido no nosso banco de dados e
sua consulta poderá ser realizada via painel Simova pelo endereço “https://slcagricola.h.simova.cloud/”. O ID
gerado é um sequencial interno que é usado no cadastro de outras tabelas.
- 11 -
Modelo Equipamento
No cadastro de modelo de equipamento será necessário fazer um POST no url:

https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/modelo_equipamento. Assim, um request realizado pelos
Request

--url: https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/modelo_equipamento
--[
{
"Descricao": "AUTOMACAO DA MAQUINA",
"CodigoTipoEquipamento": "AUT",
"Ativo": "1"
}
]
Response
[
{
"type": "success",
"msg": "Cadastro de Modelo Equipamento inserido com sucesso",
"field": "",
"id": "43"
}
]
Com essas informações o cadastro de modelo do equipamento será inserido no nosso banco de
dados e sua consulta poderá ser realizada via painel Simova pelo endereço
“https://slcagricola.h.simova.cloud/”. O ID gerado é um sequencial interno que é usado no cadastro de outras
tabelas.
- 12 -
Equipamento
No cadastro de equipamento será necessário fazer um POST no url:

https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/equipamento. A
ssim, um request realizado pelos campos da
tabela será necessário. Segue o modelo de resultado:
Request

--url: https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/equipamento
--[
{
"Descricao": "COLHEITADEIRA MASSEY FERGUSON 9790",
"CodigoEquipamento": "000PPF20P8S000247",
"Chassi": "000PPF20P8S000247",
"SeqCliente": "17293",
"SeqModeloEquipamento": "43",
"Modelo": "2016",
"Ativo": "1"
}
]
Response
[
{
"type": "success",
"msg": "Cadastro de Equipamento inserido com sucesso",
"field": "",
"id": "1"
}
]
Com essas informações o cadastro de equipamento será inserido no nosso banco de dados e sua
consulta poderá ser realizada via painel Simova pelo endereço “https://slcagricola.h.simova.cloud/”. O ID
- 13 -
Mediçao
No cadastro de medição será necessário fazer um POST no url:

https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/medicao. Assim, um request realizado pelos campos da
Request

--url: https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/medicao
--[
{
"SequencialEquipamento": "66",
"Medicao" : "3812.0",
"Ativo": "1"
}
]
Response
[
{
"type": "success",
"msg": "Cadastro de Medicao inserido com sucesso",
"field": "",
"id": "1"
}
]
Com essas informações o cadastro de medição será inserido no nosso banco de dados e sua consulta
sequencial interno que é usado no cadastro de outras tabelas.
- 14 -
Produto
No cadastro de produto será necessário fazer um POST no url:

https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/produto. Assim, um request realizado pelos campos da
Request

--url: https://slcagricola.h.simova.cloud/nfs/api/v1/sync/produto
--[
{
"Descricao": "Filtro de óleo do motor RE57394",
"CodigoProduto" : "1008641",
"SequnidadeMedida": "2",
"Ativo": "1"
}
]
Response
[
{
"type": "success",
"msg": "Cadastro de Produto inserido com sucesso",
"field": "",
"id": "1"
}
]
Com essas informações o cadastro de produto será inserido no nosso banco de dados e sua consulta
- 15 -
Serviço
No cadastro de equipamento será necessário fazer um POST no url:

https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/equipamento. Assim, um request realizado pelos campos da
Request

--url: https://slcagricola.h.simova.cloud/nfs/api/v1/sync/servico
--[
{
"Descricao": "DESLOCAMENTO KM",
"CodigoServico": "WTYSUBL8",
"TempoPadrao": "60",
"SeqGrupoServico": "1",
"Ativo": "1"
}
]
Response
[
{
"type": "success",
"msg": "Cadastro de Serviço inserido com sucesso",
"field": "",
"id": "1"
}
]
Com essas informações o cadastro de serviço será inserido no nosso banco de dados e sua consulta
- 16 -
PLANO MANUTENCAO
No cadastro de plano de manutenção será necessário fazer um POST no url:

https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/plano_manutencao. Assim, um request realizado pelos
Request

--url: https://slcagricola.h.simova.cloud/nfs/api/v1/sync/plano_manutencao
--[
{
"Descricao": "PREDITIVA TR 7500 375H",
"SeqModeloEquipamento" : "1",
"MedicaoMinimo": "325",
"MedicaoMaximo": "375",
"Observacao": "TROCAR FILTRO E OLEO DE MOTOR E CUBOS",
"Ativo": "1"
}
]
Response
[
{
"type": "success",
"msg": "Cadastro de Plano Manutencao inserido com sucesso",
"field": "",
"id": "1"
}
]
Com essas informações o cadastro de plano de manutenção será inserido no nosso banco de dados e
sua consulta poderá ser realizada via painel Simova pelo endereço “https://slcagricola.h.simova.cloud/”. O ID
- 17 -
PLANO MANUTENCAO PRODUTO
No cadastro de plano de manutenção de produto será necessário fazer um POST no url:

https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/plano_manutencao_produto. Assim, um request realizado
pelos campos da tabela será necessário. Segue o modelo de resultado:
Request

--url: https://slcagricola.h.simova.cloud/nfs/api/v1/sync/plano_manutencao_produto
--[
{
"SeqPlanoManutencao" : "4",
"SeqProduto": "1",
"Quantidade": "1",
"Ativo": "1"
}
]
Response
[
{
"type": "success",
"msg": "Cadastro de Plano Manutencao de Produto inserido com sucesso",
"field": "",
"id": "1"
}
]
Com essas informações o cadastro de plano de manutenção de produto será inserido no nosso banco
de dados e sua consulta poderá ser realizada via painel Simova pelo endereço
tabelas.
- 18 -
PLANO MANUTENCAO SERVICO
No cadastro de plano de manutenção de serviço será necessário fazer um POST no url:

https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/plano_manutencao_servico. A
ssim, um request realizado
pelos campos da tabela será necessário. Segue o modelo de resultado:
Request

--url: https://slcagricola.h.simova.cloud/nfs/api/v1/sync/plano_manutencao_servico
--[
{
"SeqPlanoManutencao" : "46",
"SeqServico": "45",
"TempoPadrao": "1",
"Ativo": "1"
}
]
Response
[
{
"type": "success",
"msg": "Cadastro de Plano Manutencao de Servico inserido com sucesso",
"field": "",
"id": "1"
}
]
Com essas informações o cadastro de plano de manutenção de serviço será inserido no nosso banco
de dados e sua consulta poderá ser realizada via painel Simova pelo endereço
tabelas.
- 19 -
PEÇA
No cadastro de peças será necessário fazer um POST no url:

https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/peca. A
ssim um request realizado pelos campos da tabela
será necessários. Segue o modelo de resultado:
Request

--url: https://slcagricola.h.simova.cloud/nfs/api/v1/sync/peca
--[
{
"Descricao": "CAR FRESHNER",
"CodigoPeca" : "0078"
}
]
Response
[
{
"type": "success",
"msg": "Cadastro de Peca inserido com sucesso",
"field": "",
"id": "2385"
}
]
Com essas informações o cadastro de peças será inserido no nosso banco de dados e sua consulta poderá
ser realizada via painel Simova pelo endereço “https://slcagricola.h.simova.cloud/”. O ID gerado é um
sequencial interno que é usado em outras operações.
- 20 -
Ordem de Serviço (OS)
No cadastro de OS será necessário fazer um POST no url:

https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/os. A
ssim, um request realizado pelos campos da tabela
será necessário. Segue o modelo de resultado:
Request

--url: https://slcagricola.h.simova.cloud/nfs/api/v1/sync/os
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJuZnMubG9jYWwiLCJuYW1lIjoic2ltb3ZhLmFkb
WluIiwiZW1haWwiOiJzaW1vdmEuYWRtaW5Ac2ltb3ZhLmNvbS5iciIsImZpbGlhbCI6IlBBTE0iLCJsb2N
hbCI6bnVsbCwiZXhwIjoiMjAyMC0wMS0yNyAxNjowNDozNSJ9.R+i2r7D9MTVHPND62I636hW5rOSn
N+\/L\/s6GoGzKV3Y=' \
--[
{
"Ativo": "1",
"CodigoOS": "85388",
"Observacao": "OS UTILIZADA PARA TESTE SIMOVA",
"DataAbertura": "2020-08-06 08:43:00",
"SeqStatusOS": "3",
"SeqtipoOS": "9",
"SeqTipoAtendimento": "1",
"SeqCliente": "13986",
"SeqEquipamento": "4916"
}
]
Response
[
{
"type": "success",
"msg": "Cadastro de OrdemServico inserido com sucesso",
"field": "",
"id": "1"
}
]
- 21 -
OS relacionada ao Serviço (OSxSERVICO)
No cadastro de OSxSERVICO será necessário fazer um POST no url:

https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/os_servico. Assim, um request realizado pelos campos da
Request

--url: https://slcagricola.h.simova.cloud/nfs/api/v1/sync/os_servico
--[
{
"FilialOS": "1",
"LocalOS": "1",
"Ativo": "1",
"SeqCodigoOS": "167",
"SeqCodigoServico": "194",
"TempoPadrao":"60",
"CodigoOsCapa":"36180",
"NroItem":"2"
}
]
Response
[
{
"type": "success",
"msg": "Cadastro de OS servico inserido com sucesso",
"field": "",
"id": "1"
}
]
- 22 -
OS relacionada ao Técnico (OSxTECNICO)
No cadastro de OSxTECNICO será necessário fazer um POST no url:

https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/os_tecnico. Assim, um request realizado pelos campos da
Request

--url: https://slcagricola.h.simova.cloud/nfs/api/v1/sync/os_tecnico
--[
{
"FilialOS": "1",
"LocalOS": "1",
"Ativo": "1",
"SeqCodigoOS": "167",
"SeqCodigofuncionario": "23",
"StatusOS":"3"
}
]
Response
[
{
"type": "success",
"msg": "Cadastro de OS tecnico inserido com sucesso",
"field": "",
"id": "1"
}
]
- 23 -
OS relacionada à PECAS (OSxPECA)
No cadastro de OSxPECA será necessário fazer um POST no url:

https://s lcagricola.h.simova.cloud/nfs/api/v1/sync/os_peca. Assim, um request realizado pelos campos da
Request

--url: https://slcagricola.h.simova.cloud/nfs/api/v1/sync/os_peca
--[
{
"Descricao": "CAR FRESHNER",
"FilialOS": "5",
"CodigoSeqPeca" : "2385",
"CodigoSeqOs" : "676",
"QtdRequisitada": "6"
}
]
Response
[
{
"type": "success",
"msg": "Cadastro de OS peca inserido com sucesso",
"field": "",
"id": "1"
}
]
- 24 -
Integração
Na integração é feito um GET a partir o Id que é enviado o sincronismo o mesmo deve ser retornado
quando quer se obter as informações de volta para o sistema de terceiro.
A url é https://slcagricola.h.simova.cloud/nfs/api/v1/integration/{entidade}
{entidade}: é configurado a partir da necessidade do cliente
Exemplo
Supondo que foi feito um sincronismo de Ordem de Serviço, que é a entidade os, e o ID gerado no
SmartOS é 10.
Request
curl --request GET \

--url https://slcagricola.h.simova.cloud/nfs/api/v1/integration/os \
--data '{
"id": "10"
- 25 -
}'
Response
[
{
"CodigoEmpresa": "Simova",
"FilialOS": "1",
"StatusOS": "Encerrada",
"IDStatusOS": "3",
"Equipamento": [
{
"Chassi": "312321312",
"Horimetro": "100",
"IdImagemChassi": "",
"IdImagemHorimetro": "1",
"DataLeitura": "2019-11-28 15:21:01"
}
],
"Dtac": [
{
"PecaCausadora": "1231312"
}
],
"AptHorasTrabalhadas": [
{
"SeqServico": "001-0002-0000",
"CodigoParada": "",
"DescParada": "",
"TipoApontamento": 1,
"CodigoEmpresaTec": "PALM",
"FlagServicoManual": "0",
"DataInicialApontamento": "2019-12-26 16:09:14",
"DataFinalApontamento": "2019-12-26 17:09:21",
"TempoApontado": "120",
"CodigoTecnico": "5"
},
{
"SeqServico": "",
"CodigoParada": "1",
"DescParada": "À DISPOSIÇÃO",
"TipoApontamento": 2,
"CodigoEmpresaTec": "Simova",
- 26 -
"FlagServicoManual": "1",
"DataInicialApontamento": "2019-12-26 16:09:14",
"DataFinalApontamento": "2019-12-26 17:09:21",
"TempoApontado": "120",
"CodigoTecnico": "5"
}
],
"PecasAplicacas": [
{
"CodigoPeca": "DIV538",
"QuantidadeAplicada": "0"
},
{
"CodigoPeca": "84565924",
"QuantidadeAplicada": "0"
}
]
}
]
Nisso é enviada todas informações da OS que estão configuradas para retorno, que geralmente é o
Apontamento de Horas Trabalhadas, Peças usadas na OS e etc.
- 27 -
Referência
[1] Json Object - Na autenticação é usada a seguintes estrutura para enviar as informações:
{
“chave”: “valor”
}
[2] Json Array - No sincronismo de dados é usado a seguinte estrutura para enviar as informações:
[
{
“chave1”:”valor1”
},
{
“chave2”: “valor2”
}
]
- 28 -

Simova NFS API: Apresentação

Enviado por

Dados do documento

Descrição original:

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Simova NFS API: Apresentação

Enviado por

Direitos autorais:

Formatos disponíveis

Simova NFS API

Elaborado por Alan Mocellin em 04/01/2021

DESCRICAO VARCHAR(250) Descrição do cliente

LOJA VARCHAR(20) Loja do cliente

ENDERECO VARCHAR(250) Endereço do cliente

MUNICIPIO VARCHAR(250) Município do cliente

CODIGOCLIENTE VARCHAR(20) Código do cliente

TELEFONE VARCHAR(100) Telefone do cliente

IDENTIFICACAO VARCHAR(100) Identificação do cliente

ATIVO VARCHAR(10) Cliente ativo Sim-1/Não-0

CELULAR VARCHAR(100) Celular do cliente

INSCRICAOESTADUAL VARCHAR(100) Inscrição estadual do cliente

BAIRRO VARCHAR(100) Bairro do cliente

CEP VARCHAR(100) CEP do cliente

EMAIL VARCHAR(100) E-mail do cliente

CNPJCPF VARCHAR(20) CNPJ ou CPF do cliente

NROPROPRIETARIO VARCHAR(50) Número do proprietário (endereço)

DESCRICAO VARCHAR(250) Descrição do tipo de equipamento

CODIGOTIPOEQUIPAMENTO VARCHAR(20) Código do tipo de equipamento

ATIVO VARCHAR(10) Tipo equip ativo

DESCRICAO VARCHAR(250) Descrição do modelo equipamento

SEQTIPOEQUIPAMENTO VARCHAR(100) Sequencial do tipo equipamento

ATIVO VARCHAR(10) Modelo equip ativo

MODELO VARCHAR(100) Modelo do equipamento

DESCRICAO VARCHAR(250) Descrição do equipamento

CODIGOEQUIPAMENTO VARCHAR(20) Código do equipamento

CHASSI VARCHAR(100) Chassi do equipamento

SEQCLIENTE VARCHAR(100) Sequencial do cliente (interno)

ATIVO VARCHAR(10) Equipamento ativo

MODELO VARCHAR(100) Modelo do equipamento

SEQMODELOEQUIPAMENTO VARCHAR(100) Sequencial do modelo do equip.

SEQEQUIPAMENTO VARCHAR(100) Sequencial do equipamento

MEDICAO DECIMAL(7.1) Medição do horímetro/odômetro

DESCRICAO VARCHAR(250) Descrição do produto

CODIGOPRODUTO VARCHAR(50) Código do produto

SEQUNIMADEMEDIDA VARCHAR(100) Sequencial da unidade de medida:

ATIVO VARCHAR(10) produto ativo

DESCRICAO VARCHAR(250) Descrição do serviço

CODIGOSERVICO VARCHAR(20) Código do serviço

TEMPOPADRAO VARCHAR(100) Tempo padrão do serviço

SEQGRUPOSERVICO VARCHAR(100) Sequencial do grupo serviço:

ATIVO VARCHAR(10) Equipamento ativo

DESCRICAO VARCHAR(250) Descrição do plano de manutenção

SEQMODELOEQUIPAMENTO VARCHAR(20) Sequencial do modelo de

MEDICAOMINIMO VARCHAR(100) Medição mínima do plano de

MEDICAOMAXIMO VARCHAR(100) Medição máxima do plano de

OBSERVACAO Observação do plano de manutenção

PLANO MANUTENCAO DO PRODUTO

SEQPLANOMANUTENCAO VARCHAR(250) Sequencial do plano de manutenção

SEQPRODUTO VARCHAR(20) Sequencial do produto

QUANTIDADE VARCHAR(100) Quantidade do plano de manutenção

ATIVO VARCHAR(10) Plano de manutenção do produto

PLANO MANUTENCAO DO SERVICO

SEQPLANOMANUTENCAO VARCHAR(250) Sequencial do plano de manutenção

SEQSERVICO VARCHAR(20) Sequencial do serviço

TEMPOPADRAO VARCHAR(100) Tempo padrão do plano de

ATIVO VARCHAR(10) Plano de manutenção do serviço ativo

DESCRICAO VARCHAR(250) Descrição da peça

CODIGOPECA VARCHAR(20) Código da peça

ATIVO VARCHAR(10) Peça ativa

FILIALOS VARCHAR(100) Filial da OS

ATIVO VARCHAR(10) OS ativa:

A chave token será usada no restante dos sincronismo e integração de dados.

No cadastro de cliente será necessário fazer um POST no url:

curl --request POST \

No cadastro de tipo de equipamento será necessário fazer um POST no url:

curl --request POST \

No cadastro de modelo de equipamento será necessário fazer um POST no url:

curl --request POST \

No cadastro de equipamento será necessário fazer um POST no url:

curl --request POST \

No cadastro de medição será necessário fazer um POST no url:

curl --request POST \

No cadastro de produto será necessário fazer um POST no url:

curl --request POST \

No cadastro de equipamento será necessário fazer um POST no url:

curl --request POST \

No cadastro de plano de manutenção será necessário fazer um POST no url:

curl --request POST \

No cadastro de plano de manutenção de produto será necessário fazer um POST no url:

curl --request POST \

No cadastro de plano de manutenção de serviço será necessário fazer um POST no url:

curl --request POST \

No cadastro de peças será necessário fazer um POST no url:

curl --request POST \

No cadastro de OS será necessário fazer um POST no url:

No cadastro de OSxSERVICO será necessário fazer um POST no url:

No cadastro de OSxTECNICO será necessário fazer um POST no url:

No cadastro de OSxPECA será necessário fazer um POST no url:

{entidade}: é configurado a partir da necessidade do cliente