Escolar Documentos
Profissional Documentos
Cultura Documentos
CONCEITOS
Integração
É o processo que envia os dados dos apontamentos realizados pelos técnicos/mecânicos do SmartOS para o ERP do cliente.
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
smartos.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.
-1-
password Sim Password do usuário
Requisições e Respostas
Response
{
"type": "success",
"msg": "Token gerado com sucesso.",
"token":
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJyb3Rhb2VzdGUuc2ltb3ZhLmNsb3VkIiwibmFtZ
SI6ImFwaXdzQHNpbW92YS5jb20uYnIiLCJlbWFpbCI6ImFwaXdzQHNpbW92YS5jb20uYnIiLCJmaWx
pYWwiOiJDdWlhYlx1MDBlMSIsImxvY2FsIjpudWxsLCJleHAiOiIyMDIyLTA0LTA4IDA5OjA2OjAxIn0=.EL
ZXzkixBNZNJQ3GdFE2U9GmjfeS9AAWNl+xF583USg=",
"user": "apiws@simova.com.br"
}
-2-
Sincronismo
No sincronismo todas as chamadas são feitas por meio do método POST e no corpo é enviado um
Json Array [2].
A url é https://slcagricola.h.simova.cloud/nfs/api/v1/sync/{entidade}
Serviços
Tabela de serviços
Campo Descrição API Tipo de dados Chave Campo Descrição
Primária(PK) Obrigatório
-3-
Serviços - API
Request
Response
[
{
"type": "success",
"msg": "Cadastro de Servico inserido com sucesso",
"field": "",
"id": "8365"
}
]
Unidade Medida
-4-
1-Sim;0-Não
Request
Response
[
{
"type": "success",
"msg": "Cadastro de Unidade Medida inserido com sucesso",
"field": "",
"id": "4"
}
]
-5-
Medicao
Tabela de medicao
Campo Descrição API Tipo de dados Chave Campo Descrição
Primária(PK) Obrigatório
Medicao - API
Request
Response
[
{
"type": "success",
"msg": "Cadastro de Medicao inserido com sucesso",
"field": "",
-6-
"id": "8365"
}
]
Tipo OS
Tabela de tipo de OS
Campo Descrição API Tipo de dados Chave Campo Descrição
Primária(PK) Obrigatório
Tipo OS - API
Request
Response
[
{
"type": "success",
"msg": "Cadastro de Tipo OS inserido com sucesso",
"field": "",
-7-
"id": "4"
}
]
Causa desvio
Request
Response
-8-
{
"type": "success",
"msg": "Cadastro de causa desvio inserido com sucesso",
"field": "",
"id": "4"
}
]
Marca equipamento
Request
-9-
Response
[
{
"type": "success",
"msg": "Cadastro de Marca equipamento inserido com sucesso",
"field": "",
"id": "4"
}
]
Tipo equipamento
Request
- 10 -
"CodigoMarcaAtivo": "100"
}
]'
Response
[
{
"type": "success",
"msg": "Cadastro de Tipo equipamento inserido com sucesso",
"field": "",
"id": "4"
}
]
Modelo equipamento
Request
- 11 -
GQUf+oreyT0LkH4o64fiMcOOO\/H9P\/\/H2VyA=' \
--cookie PHPSESSID=cd1ko0dpuj7h3dl07qo7fk56om \
--data '[
{
"RegistroAtivo": "1",
"CodigoModeloAtivo": "1001",
"DescricaoModeloAtivo": "Teste",
"CodigoTipoAtivo": "100"
}
]'
Response
[
{
"type": "success",
"msg": "Cadastro de Modelo equipamento inserido com sucesso",
"field": "",
"id": "4"
}
]
Equipamento
Tabela do ativo
Campo Descrição API Tipo de dados Chave Campo Descrição
Primária(PK) Obrigatório
- 12 -
O 0:Horímetro;1:Odômetro
Equipamento - API
Request
Response
- 13 -
[
{
"type": "success",
"msg": "Cadastro de Equipamento inserido com sucesso",
"field": "",
"id": "4"
}
]
Funcionario
Tabela de funcionario
Campo Descrição API Tipo de dados Chave Campo Descrição
Primária(PK) Obrigatório
- 14 -
Funcionario - API
Request
Response
[
{
"type": "success",
- 15 -
"msg": "Cadastro de Funcionario inserido com sucesso",
"field": "",
"id": "4"
}
]
Plano Manutencao
Request
- 16 -
"CodigoPlanoManutencao": "100",
"DescricaoPlanoManutencao": "Teste",
"CodigoModeloAtivo": "100",
"MedicaoMinimo": "1",
"MedicaoMaximo": "100",
"Observacao": "Teste API",
"TipoMedicao": "1"
}
]'
Response
[
{
"type": "success",
"msg": "Cadastro de Plano manutencao inserido com sucesso",
"field": "",
"id": "4"
}
]
Tipo Manutencao
- 17 -
Tipo Manutencao - API
Request
Response
[
{
"type": "success",
"msg": "Cadastro de Tipo manutencao inserido com sucesso",
"field": "",
"id": "4"
}
]
Peca
- 18 -
1-Sim;0-Não
Peca - API
Request
Response
- 19 -
{
"type": "success",
"msg": "Cadastro de Peca inserido com sucesso",
"field": "",
"id": "4"
}
]
OS
Tabela de OS
Campo Descrição API Tipo de dados Chave Campo Descrição
Primária(PK) Obrigatório
- 20 -
oldagem
OS - API
Request
- 21 -
Response
[
{
"type": "success",
"msg": "Cadastro de OS inserido com sucesso",
"field": "",
"id": "4"
}
]
OS Peca
OS Peca - API
Request
- 22 -
"QtdRequisitada": "100"
}
]'
Response
[
{
"type": "success",
"msg": "Cadastro de OS peca inserido com sucesso",
"field": "",
"id": "4"
}
]
OS Servico
Tabela de OS servico
Campo Descrição API Tipo de dados Chave Campo Descrição
Primária(PK) Obrigatório
OS Servico - API
Request
- 23 -
{
"RegistroAtivo": "1",
"CodigoOs": "100",
"CodigoServico": "100",
"TempoPadrao": "60"
}
]'
Response
[
{
"type": "success",
"msg": "Cadastro de OS servico inserido com sucesso",
"field": "",
"id": "4"
}
]
Integração
Na integração é feito um GET a partir do ID que é enviado o sincronismo o mesmo deve ser retornado
quando se quer obter as informações de volta para o sistema de terceiro.
A url é https://slcagricola.h.simova.cloud/nfs/api/v1/integration/{entidade}
- 24 -
BOLETIM
Tabela de boletim
Campo Descrição API Tipo de dados Chave Primária(PK) Campo Obrigatório Descrição
IMPORTANTE!! Para a API de boletim as informações de técnico são retornadas de acordo com a filial
autenticada.
Request
- 25 -
Response
[
{
"Filial": "Fazenda Planeste",
"Local": "MA-Manutenção",
"SequencialBoletim": "1644348820172",
"DataInicialBoletim": "2022-02-08 16:30:14",
"DataFinalBoletim": "2022-02-09 04:28:22",
"BoletimAtivo": "1",
"HorasBoletim": "43088",
"NomeFuncionario": "JOSE CARLOS MENDES CARDOSO",
"CrachaFuncionario": "192698"
},
{
"Filial": "Fazenda Planeste",
"Local": "MA-Manutenção",
"SequencialBoletim": "1644349151181",
"DataInicialBoletim": "2022-02-08 16:35:43",
"DataFinalBoletim": "2022-02-09 05:01:53",
"BoletimAtivo": "1",
"HorasBoletim": "44770",
"NomeFuncionario": "CAIO FERNANDO ASSUNCAO LIMA",
"CrachaFuncionario": "194760"
}
Nisso é enviada todas informações do boletim que estão configuradas para retorno.
APONTAMENTO
Tabela de apontamento do técnico
Campo Descrição API Tipo de dados Chave Primária(PK) Campo Obrigatório Descrição
- 26 -
FK_SEQ_DB_DEVICE SeqBoletim VARCHAR(100) Sim Sim Sequencial do boletim
(FK)
IMPORTANTE!! Para a API de apontamento as informações de técnico são retornadas de acordo com a
filial autenticada.
Request
- 27 -
--header 'authorization:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzbGNhZ3JpY29sYS5oLnNpbW92YS5jbG91ZCI
sIm5hbWUiOiJhcGl3c0BzaW1vdmEuY29tLmJyIiwiZW1haWwiOiJhcGl3c0BzaW1vdmEuY29tLmJyIiwiZ
mlsaWFsIjoiRmF6ZW5kYSBQbGFuZXN0ZSIsImxvY2FsIjpudWxsLCJleHAiOiIyMDIyLTA2LTE1IDA4Oj
QyOjExIn0=.Nw5\/hX9jhuGc6t71EBxUUL2npVFsXozAM5MWi0DdlgI=' \
--cookie PHPSESSID=cd1ko0dpuj7h3dl07qo7fk56om \
--data '{
"periodo": {
"begin": "2022-02-08 13:13:38",
"end" : "2022-02-08 23:59:59"
}
}'
Response
[
{
"Filial": "Fazenda Planeste",
"Local": "MA-Manutenção",
"SequencialApontamento": "1644337228622",
"SeqBoletim": "1644332465909",
"DataInicialBoletim": "2022-02-08 11:57:29",
"DataFinalBoletim": "2022-02-09 21:10:19",
"DataInicialApontamento": "2022-02-08 13:17:00",
"DataFinalApontamento": "2022-02-08 14:03:18",
"ApontamentoAtivo": "1",
"CodigoOs": "",
"OsCriada": "",
"CodigoOsApontamento": "",
"FlagDeslocamento": "0",
"TipoApontamento": "2",
"CodigoServico": "",
"DescricaoParada": "Deslocamento",
"HorasApontamento": "2778",
"DescricaoComponente": "",
"DescricaoSubsistema": "",
"DescricaoSistema": "",
"Chassi": ""
},
{
"Filial": "Fazenda Planeste",
"Local": "MA-Manutenção",
- 28 -
"SequencialApontamento": "1644337343726",
"SeqBoletim": "1644318367529",
"DataInicialBoletim": "2022-02-08 08:02:47",
"DataFinalBoletim": "2022-02-08 18:40:56",
"DataInicialApontamento": "2022-02-08 13:19:04",
"DataFinalApontamento": "2022-02-08 17:33:59",
"ApontamentoAtivo": "1",
"CodigoOs": "",
"OsCriada": "991644328184187",
"CodigoOsApontamento": "1644328184187",
"FlagDeslocamento": "0",
"TipoApontamento": "1",
"CodigoServico": "CA-1.4.1",
"DescricaoParada": "",
"HorasApontamento": "15295",
"DescricaoComponente": "Coletor",
"DescricaoSubsistema": "Coletor",
"DescricaoSistema": "Motor\/Arrefecimento\/Combustível",
"Chassi": "1CQS790AAK013012"
}
]
- 29 -