Blueprint

Schema declarativo da integração NBS.

Visão geral

Dados da integração

Campo	Valor
Key	nbs
Porta	4001
Ícone	undefined

Credenciais (múltiplas)

Campo	Tipo	Obrigatório	Sensível
client_id	string	Sim	Sim
client_secret	string	Sim	Sim

Configuração (múltipla)

Campo	Tipo	Obrigatório	Default
cod_empresa	number	Sim	—

Handlers

get-agenda (inbound, gateway)

Lista agendamentos com filtros (período, consultor, placa, chassi, CPF, status)

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

get-agenda-horarios (inbound, gateway)

Verifica horários disponíveis para agendamento em um período

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

get-cliente (inbound, gateway)

Busca dados do cliente e frota de veículos por CPF ou placa

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

get-cliente-revisao (inbound, gateway)

Lista clientes próximos da revisão programada

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

get-consultor (inbound, gateway)

Lista consultores de uma empresa com horários de atendimento

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

get-empresa (inbound, gateway)

Lista lojas/empresas ativas no sistema

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

get-os-tipo (inbound, gateway)

Retorna tipos de ordens de serviço de uma empresa

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

get-os (inbound, gateway)

Retorna histórico de ordens de serviço de um veículo pelo chassi

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

get-servico (inbound, gateway)

Retorna informações de serviços disponíveis

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

get-veiculo (inbound, gateway)

Retorna modelos de veículos disponíveis

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

post-agenda (outbound, gateway)

Cria um novo agendamento na oficina

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

put-agenda (outbound, gateway)

Altera um agendamento existente

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

delete-agenda (outbound, gateway)

Cancela um agendamento existente

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

post-cliente-revisao-status (outbound, gateway)

Verifica se um veículo necessita de revisão

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

API Gateway

Endpoints públicos para consumo por outros produtos.

get-agenda (inbound)

Lista agendamentos com filtros (período, consultor, placa, chassi, CPF, status)

POST /gateway/nbs/get-agenda

Headers:

Header	Descrição
Content-Type	application/json
x-tenant-id	ID do tenant

Body (query):

Param	Tipo
codOsAgenda	string
dtIni	string
dtFim	string
codConsultor	string
placa	string
chassi	string
cpf	string
status	string
page	string
size	string

Response:

Campo	Tipo
[]	undefined
[].codAgendamento	number
[].numeroPreOs	number
[].observacoes	string
[].dataCriacao	string
[].status	string
[].descricaoStatus	string
[].cliente	string
[].veiculo	string
[].codEmpresa	number
[].consultor	string
[].dataAgendamento	string
[].km	number
[].servicos[]	undefined
[].servicos[].value	string

get-agenda-horarios (inbound)

Verifica horários disponíveis para agendamento em um período

POST /gateway/nbs/get-agenda-horarios

Headers:

Header	Descrição
Content-Type	application/json
x-tenant-id	ID do tenant

Body (query):

Param	Tipo
dtIni	string
dtFim	string
codConsultor	string

Response:

Campo	Tipo
[]	undefined
[].codConsultor	string
[].nomeConsultor	string
[].data	string
[].horarios[]	undefined
[].horarios[].value	string

get-cliente (inbound)

Busca dados do cliente e frota de veículos por CPF ou placa

POST /gateway/nbs/get-cliente

Headers:

Header	Descrição
Content-Type	application/json
x-tenant-id	ID do tenant

Body (query):

Param	Tipo
cpf	string
placa	string

Response:

Campo	Tipo
codigo	number
nome	string
cpf	string
telefone	string
email	string
veiculos[]	undefined
veiculos[].value	string

get-cliente-revisao (inbound)

Lista clientes próximos da revisão programada

POST /gateway/nbs/get-cliente-revisao

Headers:

Header	Descrição
Content-Type	application/json
x-tenant-id	ID do tenant

Body (query):

Param	Tipo
diasAntecedencia	string
margemKm	string
apenasSemAgendamento	string

Response:

Campo	Tipo
content[]	undefined
content[].value	string

get-consultor (inbound)

Lista consultores de uma empresa com horários de atendimento

POST /gateway/nbs/get-consultor

Headers:

Header	Descrição
Content-Type	application/json
x-tenant-id	ID do tenant

Body (query):

Param	Tipo
ativo	string

Response:

Campo	Tipo
[]	undefined
[].codConsultor	string
[].nomeConsultor	string
[].horaInicio	string
[].horaFim	string
[].intervaloMatutino	string
[].intervaloVespertino	string
[].ativo	string

get-empresa (inbound)

Lista lojas/empresas ativas no sistema

POST /gateway/nbs/get-empresa

Headers:

Header	Descrição
Content-Type	application/json
x-tenant-id	ID do tenant

Response:

Campo	Tipo
[]	undefined
[].codEmpresa	number
[].nome	string
[].endereco	string
[].telefone	string

get-os-tipo (inbound)

Retorna tipos de ordens de serviço de uma empresa

POST /gateway/nbs/get-os-tipo

Headers:

Header	Descrição
Content-Type	application/json
x-tenant-id	ID do tenant

Body (query):

Param	Tipo
tipoOs	string
descricao	string

Response:

Campo	Tipo
[]	undefined
[].tipoOs	string
[].descricao	string
[].classificacaoOs	string
[].valorHora	number

get-os (inbound)

Retorna histórico de ordens de serviço de um veículo pelo chassi

POST /gateway/nbs/get-os

Headers:

Header	Descrição
Content-Type	application/json
x-tenant-id	ID do tenant

Body (query):

Param	Tipo
chassi	string
limite	string

Response:

Campo	Tipo
[]	undefined
[].numeroOs	number
[].dataEmissao	string
[].dataEncerrada	string
[].statusOs	string
[].km	number
[].valorTotal	number
[].consultor	string
[].servicos[]	undefined
[].servicos[].value	string
[].pecas[]	undefined
[].pecas[].value	string

get-servico (inbound)

Retorna informações de serviços disponíveis

POST /gateway/nbs/get-servico

Headers:

Header	Descrição
Content-Type	application/json
x-tenant-id	ID do tenant

Body (query):

Param	Tipo
tipoOs	string
codModelo	string
codProduto	string
codServico	string
descricao	string
listaCodServico	string

Response:

Campo	Tipo
[]	undefined
[].codServico	string
[].descricaoServico	string
[].codProduto	number
[].codModelo	number
[].descricaoModelo	string
[].tempo	number
[].valor	number
[].cobra	boolean

get-veiculo (inbound)

Retorna modelos de veículos disponíveis

POST /gateway/nbs/get-veiculo

Headers:

Header	Descrição
Content-Type	application/json
x-tenant-id	ID do tenant

Body (query):

Param	Tipo
codMarca	string
codModelo	string
codFamilia	string
descModelo	string
descProduto	string
anoModelo	string
anoFabricacao	string
page	string
size	string

Response:

Campo	Tipo
content	string
pageable	string

post-agenda (outbound)

Cria um novo agendamento na oficina

POST /gateway/nbs/post-agenda

Headers:

Header	Descrição
Content-Type	application/json
x-tenant-id	ID do tenant

Body (body):

Campo	Tipo
codEmpresa	number
dataHora	string
consultor	string
tipoOs	string
km	number
observacao	string
cliente	string
veiculo	string
servicos[]	undefined
servicos[].value	string

Response:

Campo	Tipo
value	string

put-agenda (outbound)

Altera um agendamento existente

POST /gateway/nbs/put-agenda

Headers:

Header	Descrição
Content-Type	application/json
x-tenant-id	ID do tenant

Body (body):

Campo	Tipo
codAgendamento	number
codEmpresa	number
codConsultor	string
dataHora	string
servicos[]	undefined
servicos[].value	string
observacao	string
status	string

Response:

Campo	Tipo
value	string

delete-agenda (outbound)

Cancela um agendamento existente

POST /gateway/nbs/delete-agenda

Headers:

Header	Descrição
Content-Type	application/json
x-tenant-id	ID do tenant

Body (body):

Campo	Tipo
codOsAgenda	number
placa	string

Response:

Campo	Tipo
value	string

post-cliente-revisao-status (outbound)

Verifica se um veículo necessita de revisão

POST /gateway/nbs/post-cliente-revisao-status

Headers:

Header	Descrição
Content-Type	application/json
x-tenant-id	ID do tenant

Body (body):

Campo	Tipo
chassi	string
quilometragemAtual	number

Response:

Campo	Tipo
necessitaRevisao	boolean
proximaRevisao	string
ultimaRevisao	string

Endpoints externos

Referência dos endpoints do sistema externo chamados pela integração.

get-agenda (inbound)

• Método: GET
• URL: {{urls.api}}/v1/agenda/{{payload.codEmpresa}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.access_token}}

Query params:

Param	Valor
codOsAgenda	{{query.codOsAgenda}}
dtIni	{{query.dtIni}}
dtFim	{{query.dtFim}}
codConsultor	{{query.codConsultor}}
placa	{{query.placa}}
chassi	{{query.chassi}}
cpf	{{query.cpf}}
status	{{query.status}}
page	{{query.page}}
size	{{query.size}}

Response:

Campo	Tipo
[]	undefined
[].codAgendamento	number
[].numeroPreOs	number
[].observacoes	string
[].dataCriacao	string
[].status	string
[].descricaoStatus	string
[].cliente	string
[].veiculo	string
[].codEmpresa	number
[].consultor	string
[].dataAgendamento	string
[].km	number
[].servicos[]	undefined
[].servicos[].value	string

get-agenda-horarios (inbound)

• Método: GET
• URL: {{urls.api}}/v1/agenda/horarios/{{payload.codEmpresa}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.access_token}}

Query params:

Param	Valor
dtIni	{{query.dtIni}}
dtFim	{{query.dtFim}}
codConsultor	{{query.codConsultor}}

Response:

Campo	Tipo
[]	undefined
[].codConsultor	string
[].nomeConsultor	string
[].data	string
[].horarios[]	undefined
[].horarios[].value	string

get-cliente (inbound)

• Método: GET
• URL: {{urls.api}}/v1/cliente/{{payload.codEmpresa}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.access_token}}

Query params:

Param	Valor
cpf	{{query.cpf}}
placa	{{query.placa}}

Response:

Campo	Tipo
codigo	number
nome	string
cpf	string
telefone	string
email	string
veiculos[]	undefined
veiculos[].value	string

get-cliente-revisao (inbound)

• Método: GET
• URL: {{urls.api}}/v1/cliente/revisao/{{payload.codEmpresa}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.access_token}}

Query params:

Param	Valor
diasAntecedencia	{{query.diasAntecedencia}}
margemKm	{{query.margemKm}}
apenasSemAgendamento	{{query.apenasSemAgendamento}}

Response:

Campo	Tipo
content[]	undefined
content[].value	string

get-consultor (inbound)

• Método: GET
• URL: {{urls.api}}/v1/consultor/{{payload.codEmpresa}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.access_token}}

Query params:

Param	Valor
ativo	{{query.ativo}}

Response:

Campo	Tipo
[]	undefined
[].codConsultor	string
[].nomeConsultor	string
[].horaInicio	string
[].horaFim	string
[].intervaloMatutino	string
[].intervaloVespertino	string
[].ativo	string

get-empresa (inbound)

• Método: GET
• URL: {{urls.api}}/v1/empresa/{{payload.codEmpresa}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.access_token}}

Response:

Campo	Tipo
[]	undefined
[].codEmpresa	number
[].nome	string
[].endereco	string
[].telefone	string

get-os-tipo (inbound)

• Método: GET
• URL: {{urls.api}}/v1/os/tipo/{{payload.codEmpresa}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.access_token}}

Query params:

Param	Valor
tipoOs	{{query.tipoOs}}
descricao	{{query.descricao}}

Response:

Campo	Tipo
[]	undefined
[].tipoOs	string
[].descricao	string
[].classificacaoOs	string
[].valorHora	number

get-os (inbound)

• Método: GET
• URL: {{urls.api}}/v1/os/{{payload.codEmpresa}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.access_token}}

Query params:

Param	Valor
chassi	{{query.chassi}}
limite	{{query.limite}}

Response:

Campo	Tipo
[]	undefined
[].numeroOs	number
[].dataEmissao	string
[].dataEncerrada	string
[].statusOs	string
[].km	number
[].valorTotal	number
[].consultor	string
[].servicos[]	undefined
[].servicos[].value	string
[].pecas[]	undefined
[].pecas[].value	string

get-servico (inbound)

• Método: GET
• URL: {{urls.api}}/v1/servico/{{payload.codEmpresa}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.access_token}}

Query params:

Param	Valor
tipoOs	{{query.tipoOs}}
codModelo	{{query.codModelo}}
codProduto	{{query.codProduto}}
codServico	{{query.codServico}}
descricao	{{query.descricao}}
listaCodServico	{{query.listaCodServico}}

Response:

Campo	Tipo
[]	undefined
[].codServico	string
[].descricaoServico	string
[].codProduto	number
[].codModelo	number
[].descricaoModelo	string
[].tempo	number
[].valor	number
[].cobra	boolean

get-veiculo (inbound)

• Método: GET
• URL: {{urls.api}}/v1/veiculo/{{payload.codEmpresa}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.access_token}}

Query params:

Param	Valor
codMarca	{{query.codMarca}}
codModelo	{{query.codModelo}}
codFamilia	{{query.codFamilia}}
descModelo	{{query.descModelo}}
descProduto	{{query.descProduto}}
anoModelo	{{query.anoModelo}}
anoFabricacao	{{query.anoFabricacao}}
page	{{query.page}}
size	{{query.size}}

Response:

Campo	Tipo
content	string
pageable	string

post-agenda (outbound)

• Método: POST
• URL: {{urls.api}}/v1/agenda/{{payload.codEmpresa}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.access_token}}

Request body:

Campo	Tipo
codEmpresa	number
dataHora	string
consultor	string
tipoOs	string
km	number
observacao	string
cliente	string
veiculo	string
servicos[]	undefined
servicos[].value	string

Response:

Campo	Tipo
value	string

put-agenda (outbound)

• Método: PUT
• URL: {{urls.api}}/v1/agenda/{{payload.codEmpresa}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.access_token}}

Request body:

Campo	Tipo
codAgendamento	number
codEmpresa	number
codConsultor	string
dataHora	string
servicos[]	undefined
servicos[].value	string
observacao	string
status	string

Response:

Campo	Tipo
value	string

delete-agenda (outbound)

• Método: DELETE
• URL: {{urls.api}}/v1/agenda/{{payload.codEmpresa}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.access_token}}

Request body:

Campo	Tipo
codOsAgenda	number
placa	string

Response:

Campo	Tipo
value	string

post-cliente-revisao-status (outbound)

• Método: POST
• URL: {{urls.api}}/v1/cliente/revisao/status/{{payload.codEmpresa}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.access_token}}

Request body:

Campo	Tipo
chassi	string
quilometragemAtual	number

Response:

Campo	Tipo
necessitaRevisao	boolean
proximaRevisao	string
ultimaRevisao	string