Blueprint

Schema declarativo da integração Demo.

Visão geral

Dados da integração

Campo	Valor
Key	demo
Porta	4000
Ícone	undefined

Credenciais

Campo	Tipo	Obrigatório	Sensível
api_key	string	Sim	Sim
dealer_code	string	Sim	Não

Configuração

Campo	Tipo	Obrigatório	Default
base_url	string	Sim	https://api.montadora-demo.com/v1
leads_per_page	number	Não	50

Handlers

get-leads (inbound, pulling)

Busca leads novos da montadora e importa para o CRM

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom
lead_id	string	id	Não
customer_name	string	nome_completo	Não
customer_email	string	email	Não
customer_phone	string	telefone	Não
vehicle_interest	string	veiculo_interesse	Não

list-vehicles (inbound, gateway)

Consulta veículos disponíveis na montadora (gateway)

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

get-vehicle (inbound, gateway)

Consulta detalhes de um veículo na montadora (gateway)

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

get-lead-status (inbound, gateway)

Consulta status de um lead na montadora (gateway)

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom

send-lead-update (outbound, pulling)

Envia atualizações de status do lead do CRM para a montadora

Mapeamentos

Campo Interno	Tipo	Mapeado de	Custom
lead_id	string	id	Não
status	string	status	Não
notes	string	—	Sim

API Gateway

Endpoints públicos para consumo por outros produtos.

list-vehicles (inbound)

Consulta veículos disponíveis na montadora (gateway)

POST /gateway/demo/list-vehicles

Headers:

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

Body (query):

Param	Tipo
page	string
per_page	string
model	string

Response:

Campo	Tipo
[]	undefined
[].id	string
[].model	string
[].year	number
[].price	number
[].available	boolean

get-vehicle (inbound)

Consulta detalhes de um veículo na montadora (gateway)

POST /gateway/demo/get-vehicle

Headers:

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

Response:

Campo	Tipo
id	string
model	string
year	number
price	number
available	boolean
color	string
engine	string
accessories	string

get-lead-status (inbound)

Consulta status de um lead na montadora (gateway)

POST /gateway/demo/get-lead-status

Headers:

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

Response:

Campo	Tipo
id	string
nome_completo	string
email	string
telefone	string
veiculo_interesse	string
status	string
created_at	date

Endpoints externos

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

fetch-leads (inbound)

• Método: GET
• URL: {{config.base_url}}/leads

Headers:

Header	Valor
Authorization	Bearer {{credentials.api_key}}
X-Dealer-Code	{{credentials.dealer_code}}

Query params:

Param	Valor
per_page	{{config.leads_per_page}}

Response:

Campo	Tipo
[]	undefined
[].id	string
[].nome_completo	string
[].email	string
[].telefone	string
[].veiculo_interesse	string

list-vehicles (inbound)

• Método: GET
• URL: {{urls.api}}/vehicles

Headers:

Header	Valor
Authorization	Bearer {{credentials.api_key}}
X-Dealer-Code	{{credentials.dealer_code}}

Query params:

Param	Valor
page	{{query.page}}
per_page	{{query.per_page}}
model	{{query.model}}

Response:

Campo	Tipo
[]	undefined
[].id	string
[].model	string
[].year	number
[].price	number
[].available	boolean

get-vehicle (inbound)

• Método: GET
• URL: {{urls.api}}/vehicles/{{payload.id}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.api_key}}
X-Dealer-Code	{{credentials.dealer_code}}

Response:

Campo	Tipo
id	string
model	string
year	number
price	number
available	boolean
color	string
engine	string
accessories	string

get-lead-status (inbound)

• Método: GET
• URL: {{urls.api}}/leads/{{payload.id}}

Headers:

Header	Valor
Authorization	Bearer {{credentials.api_key}}
X-Dealer-Code	{{credentials.dealer_code}}

Response:

Campo	Tipo
id	string
nome_completo	string
email	string
telefone	string
veiculo_interesse	string
status	string
created_at	date

push-lead-update (outbound)

• Método: PUT
• URL: {{config.base_url}}/leads/{{payload.lead_id}}/status

Headers:

Header	Valor
Authorization	Bearer {{credentials.api_key}}
X-Dealer-Code	{{credentials.dealer_code}}
Content-Type	application/json

Request body:

Campo	Tipo
status	string
observacoes	string

Response:

Campo	Tipo
id	string
status	string
updated_at	string