Introdução

Grupo Mútuo — API REST

A API REST do Bora CRM permite integrar sistemas externos ao CRM: criar, consultar, atualizar e excluir leads, clientes e cotações veiculares.

Todas as requisições e respostas usam JSON. URL base:

URL Base

https://mutuo.boracrm.app/api/

💡

Todos os endpoints REST exigem autenticação via token no header authtoken. Sem token válido a resposta é 401 Unauthorized.

Autenticação

Como funciona a autenticação

A API utiliza tokens JWT estáticos, gerados pelo painel administrativo e vinculados a um usuário de API.

Como usar o token

Envie o token em toda requisição via header HTTP:

Header obrigatório

authtoken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Exemplo com cURL

cURL

curl -X GET \
  "https://mutuo.boracrm.app/api/leads" \
  -H "authtoken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

💡

Segurança: Nunca exponha o token em código front-end ou repositórios públicos. Em caso de comprometimento, exclua o usuário de API e crie um novo pelo painel.

Autenticação

Permissões por recurso

Cada usuário de API tem permissões individuais por recurso (feature) e ação (capability). Ao tentar acessar um endpoint sem a permissão correspondente, a API retorna 401.

Capabilities disponíveis

Capability	Método HTTP	O que permite
get	GET	Listar e buscar por ID
search_get	GET /search/{termo}	Busca por texto
post	POST	Criar novo registro
put	PUT	Atualizar registro existente
delete	DELETE	Excluir registro

Recursos e suas capabilities

Nome	Recurso	Capabilities
Clientes	`customers`	getsearchpostputdelete
Leads	`leads`	getsearchpostputdelete
Cotações Veiculares	`cotacoes_veiculares`	getsearchpostputdelete
Cotações — Produtos	`cotacoes_produtos`	getsearchpostputdelete
Cotações — Itens	`cotacoes_itens`	getpostputdelete
Cotações — Combos	`cotacoes_combos`	getpostputdelete
Cotações — Tipos de Veículo	`cotacoes_tipos_veiculos`	getpostputdelete
Cotações — Franquias	`cotacoes_franquias`	getpostputdelete

Referência

Códigos de resposta

HTTP	Quando ocorre
200	Requisição executada com sucesso
401	Token ausente, inválido, expirado ou sem permissão
404	Registro não encontrado ou operação falhou
406	Dados ausentes ou formato não aceitável
409	Conflito de validação (ex: e-mail já cadastrado)

Estrutura padrão de sucesso

POST bem-sucedido

{
  "status":    true,
  "message":   "Lead add successful.",
  "record_id": 47
}

Estrutura padrão de erro

Erro de validação (409)

{
  "status":  false,
  "error": { "name": "O campo Nome do lead é obrigatório." },
  "message": "O campo Nome do lead é obrigatório."
}

💡

Sempre verifique o campo "status" da resposta — um HTTP 200 pode conter "status": false em algumas operações.

Recurso

Leads `/api/leads`

Permissão necessária: leads com a capability correspondente.

GET/api/leadsLista todos os leads›

Requisição

Resposta 200

HTTP

GET https://mutuo.boracrm.app/api/leads
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

[
  {
    "id": 47,
    "name": "Carlos Eduardo Silva",
    "email": "carlos.silva@gmail.com",
    "phonenumber": "+5511999887766",
    "company": "Transportadora Paulista Ltda",
    "status": 1,
    "assigned": 2,
    "lead_value": "25000.00",
    "dateadded": "2026-07-01 09:30:00"
  }
]

GET/api/leads/{id}Busca lead por ID›

Requisição

Resposta 200

HTTP

GET https://mutuo.boracrm.app/api/leads/47
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

{
  "id": 47,
  "name": "Carlos Eduardo Silva",
  "email": "carlos.silva@gmail.com",
  "phonenumber": "+5511999887766",
  "company": "Transportadora Paulista Ltda",
  "status": 1,
  "assigned": 2,
  "cpf_cnpj": "123.456.789-00",
  "placa_veiculo": "ABC1D23",
  "marca_veiculo": "Toyota",
  "modelo_veiculo": "Corolla XEi",
  "dateadded": "2026-07-01 09:30:00"
}

GET/api/leads/search/{termo}Busca leads por texto›

Requisição

Resposta 200

HTTP

GET https://mutuo.boracrm.app/api/leads/search/carlos
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

[{ "id": 47, "name": "Carlos Eduardo Silva", "email": "carlos.silva@gmail.com", "status": 1 }]

POST/api/leadsCria novo lead›

Requisição

✅ Resposta 200

❌ Resposta 409

HTTP + JSON

POST https://mutuo.boracrm.app/api/leads
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{
  // ── Obrigatórios ────────────────────
  "name":     "Carlos Eduardo Silva",
  "source":   1,
  "status":   1,
  "assigned": 1,

  // ── Contato ────────────────────
  "email":       "carlos.silva@gmail.com",
  "phonenumber": "+5511999887766",

  // ── Dados pessoais ────────────────────
  "cpf_cnpj":        "123.456.789-00",
  "data_nascimento": "1985-03-22",

  // ── Veículo ────────────────────
  "placa_veiculo":  "ABC1D23",
  "marca_veiculo":  "Toyota",
  "modelo_veiculo": "Corolla XEi",
  "ano_veiculo":    "2021",
  "codigo_fipe":    "005340-9",
  "valor_fipe":     118800.00,

  // ── CRM ────────────────────
  "lead_value":  25000.00,
  "description": "Cliente interessado em proteção veicular.",
  "tags":        "vip,interessado"
}

JSON

{ "status": true, "message": "Lead add successful.", "record_id": 47 }

JSON

{ "status": false, "error": { "name": "O campo Nome do lead é obrigatório." } }

PUT/api/leads/{id}Atualiza lead›

Requisição

Resposta 200

HTTP + JSON

PUT https://mutuo.boracrm.app/api/leads/47
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{
  // Envie apenas os campos que deseja alterar.
  "status":        3,
  "lead_value":    32000.00,
  "placa_veiculo": "XYZ9A87"
}

JSON

{ "status": true, "message": "Lead update successful.", "record_id": 47 }

DELETE/api/delete/leads/{id}Exclui lead›

Requisição

✅ Resposta 200

❌ Resposta 404

HTTP

DELETE https://mutuo.boracrm.app/api/delete/leads/47
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

{ "status": true, "message": "Lead deleted successfully." }

JSON

{ "status": false, "message": "Lead not found." }

Recurso

Clientes `/api/customers`

Permissão necessária: customers com a capability correspondente.

GET/api/customersLista todos os clientes›

Requisição

Resposta 200

HTTP

GET https://mutuo.boracrm.app/api/customers
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

[
  {
    "userid": 5,
    "company": "Transportadora Paulista Ltda",
    "vat": "12.345.678/0001-99",
    "phonenumber": "+5511999887766",
    "city": "São Paulo",
    "active": 1,
    "datecreated": "2026-07-01 09:30:00"
  }
]

GET/api/customers/{id}Busca cliente por ID›

Requisição

Resposta 200

HTTP

GET https://mutuo.boracrm.app/api/customers/5
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

{
  "userid": 5,
  "company": "Transportadora Paulista Ltda",
  "vat": "12.345.678/0001-99",
  "phonenumber": "+5511999887766",
  "address": "Av. Paulista, 1234",
  "city": "São Paulo",
  "state": "SP",
  "active": 1,
  "datecreated": "2026-07-01 09:30:00"
}

GET/api/customers/search/{termo}Busca clientes por texto›

Requisição

Resposta 200

HTTP

GET https://mutuo.boracrm.app/api/customers/search/transportadora
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

[{ "userid": 5, "company": "Transportadora Paulista Ltda", "active": 1 }]

POST/api/customersCria novo cliente›

Requisição

✅ Resposta 200

❌ Resposta 409

HTTP + JSON

POST https://mutuo.boracrm.app/api/customers
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{
  "company":          "Transportadora Paulista Ltda",
  "vat":              "12.345.678/0001-99",
  "phonenumber":      "+5511999887766",
  "address":          "Av. Paulista, 1234",
  "city":             "São Paulo",
  "state":            "SP",
  "zip":              "01310-100",
  "country":          32,
  "default_language": "portuguese",
  "default_currency": 1,
  "leadid":           47,
  "custom_fields": { "3": "Logística" }
}

JSON

{ "status": true, "message": "Customer add successful.", "record_id": 5 }

JSON

{ "status": false, "error": { "company": "O campo Empresa é obrigatório." } }

PUT/api/customers/{id}Atualiza cliente›

Requisição

Resposta 200

HTTP + JSON

PUT https://mutuo.boracrm.app/api/customers/5
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{ "phonenumber": "+5511888776655", "city": "Campinas" }

JSON

{ "status": true, "message": "Customer update successful.", "record_id": 5 }

DELETE/api/delete/customers/{id}Exclui cliente›

Requisição

✅ Resposta 200

❌ Resposta 404

HTTP

DELETE https://mutuo.boracrm.app/api/delete/customers/5
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

{ "status": true, "message": "Customer deleted successfully." }

JSON

{ "status": false, "message": "Customer not found." }

Cotações

Cotações Veiculares `/api/cotacoes_veiculares`

Registro de cotações de proteção veicular vinculadas a leads ou clientes.

GET/api/cotacoes_veicularesLista todas as cotações›

Requisição

Resposta 200

HTTP

GET https://mutuo.boracrm.app/api/cotacoes_veiculares
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

[{ "id": 12, "lead_id": 47, "placa": "ABC1D23", "marca": "Toyota", "modelo": "Corolla XEi", "ano": "2021", "valor_fipe": "118800.00", "status": "aberta" }]

POST/api/cotacoes_veicularesCria nova cotação›

Requisição

✅ Resposta 200

HTTP + JSON

POST https://mutuo.boracrm.app/api/cotacoes_veiculares
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{
  "lead_id": 47, "placa": "ABC1D23",
  "marca": "Toyota", "modelo": "Corolla XEi",
  "ano": "2021", "valor_fipe": 118800.00,
  "cep": "01310-100", "combo_id": 3, "produto_id": 7
}

JSON

{ "status": true, "message": "Cotação criada com sucesso.", "record_id": 12 }

PUT/api/cotacoes_veiculares/{id}Atualiza cotação›

Requisição

Resposta 200

HTTP + JSON

PUT https://mutuo.boracrm.app/api/cotacoes_veiculares/12
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{ "status": "aprovada", "combo_id": 5 }

JSON

{ "status": true, "record_id": 12 }

DELETE/api/delete/cotacoes_veiculares/{id}Exclui cotação›

Requisição

✅ Resposta 200

HTTP

DELETE https://mutuo.boracrm.app/api/delete/cotacoes_veiculares/12
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

{ "status": true, "message": "Cotação excluída." }

Cotações

Produtos `/api/cotacoes_produtos`

Produtos de proteção disponíveis para cotação.

GET/api/cotacoes_produtosLista todos os produtos›

Requisição

Resposta 200

HTTP

GET https://mutuo.boracrm.app/api/cotacoes_produtos
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

[{ "id": 7, "nome": "Proteção Total", "ativo": true, "valor_base": "299.90" }]

GET/api/cotacoes_produtos/ativosSomente produtos ativos›

Requisição

Resposta 200

HTTP

GET https://mutuo.boracrm.app/api/cotacoes_produtos/ativos
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

[{ "id": 7, "nome": "Proteção Total", "ativo": true }]

POST/api/cotacoes_produtosCria produto›

Requisição

✅ Resposta 200

HTTP + JSON

POST https://mutuo.boracrm.app/api/cotacoes_produtos
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{ "nome": "Proteção Total", "ativo": true, "valor_base": 299.90 }

JSON

{ "status": true, "record_id": 7 }

PUT/api/cotacoes_produtos/{id}Atualiza produto›

Requisição

Resposta 200

HTTP + JSON

PUT https://mutuo.boracrm.app/api/cotacoes_produtos/7
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{ "valor_base": 319.90 }

JSON

{ "status": true, "record_id": 7 }

DELETE/api/delete/cotacoes_produtos/{id}Exclui produto›

Requisição

✅ Resposta 200

HTTP

DELETE https://mutuo.boracrm.app/api/delete/cotacoes_produtos/7
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

{ "status": true, "message": "Produto excluído." }

Cotações

Itens `/api/cotacoes_itens`

Coberturas individuais vinculadas a produtos de proteção.

GET/api/cotacoes_itensLista todos os itens›

Requisição

Resposta 200

HTTP

GET https://mutuo.boracrm.app/api/cotacoes_itens
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

[{ "id": 1, "produto_id": 7, "nome": "Cobertura Roubo", "ativo": true }]

GET/api/cotacoes_itens/por_produto/{produto_id}Itens de um produto›

Requisição

Resposta 200

HTTP

GET https://mutuo.boracrm.app/api/cotacoes_itens/por_produto/7
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

[{ "id": 1, "nome": "Cobertura Roubo", "ativo": true }]

POST/api/cotacoes_itensCria item›

Requisição

✅ Resposta 200

HTTP + JSON

POST https://mutuo.boracrm.app/api/cotacoes_itens
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{ "produto_id": 7, "nome": "Cobertura Roubo", "ativo": true }

JSON

{ "status": true, "record_id": 1 }

PUT/api/cotacoes_itens/{id}Atualiza item›

Requisição

Resposta 200

HTTP + JSON

PUT https://mutuo.boracrm.app/api/cotacoes_itens/1
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{ "ativo": false }

JSON

{ "status": true, "record_id": 1 }

DELETE/api/delete/cotacoes_itens/{id}Exclui item›

Requisição

✅ Resposta 200

HTTP

DELETE https://mutuo.boracrm.app/api/delete/cotacoes_itens/1
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

{ "status": true, "message": "Item excluído." }

Cotações

Combos `/api/cotacoes_combos`

Agrupamento de produtos em combos com preço diferenciado.

GET/api/cotacoes_combosLista todos os combos›

Requisição

Resposta 200

HTTP

GET https://mutuo.boracrm.app/api/cotacoes_combos
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

[{ "id": 3, "nome": "Combo Premium", "ativo": true, "valor": "549.90" }]

POST/api/cotacoes_combosCria combo›

Requisição

✅ Resposta 200

HTTP + JSON

POST https://mutuo.boracrm.app/api/cotacoes_combos
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{ "nome": "Combo Premium", "ativo": true, "valor": 549.90, "produtos": [7, 8] }

JSON

{ "status": true, "record_id": 3 }

PUT/api/cotacoes_combos/{id}Atualiza combo›

Requisição

Resposta 200

HTTP + JSON

PUT https://mutuo.boracrm.app/api/cotacoes_combos/3
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{ "valor": 579.90 }

JSON

{ "status": true, "record_id": 3 }

DELETE/api/delete/cotacoes_combos/{id}Exclui combo›

Requisição

✅ Resposta 200

HTTP

DELETE https://mutuo.boracrm.app/api/delete/cotacoes_combos/3
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

{ "status": true, "message": "Combo excluído." }

Cotações

Tipos de Veículo `/api/cotacoes_tipos_veiculos`

Categorias de veículos aceitos para cotação (automóvel, moto, caminhonete, etc.).

GET/api/cotacoes_tipos_veiculosLista todos os tipos›

Requisição

Resposta 200

HTTP

GET https://mutuo.boracrm.app/api/cotacoes_tipos_veiculos
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

[
  { "id": 1, "nome": "Automóvel", "ativo": true },
  { "id": 2, "nome": "Motocicleta", "ativo": true }
]

POST/api/cotacoes_tipos_veiculosCria tipo›

Requisição

✅ Resposta 200

HTTP + JSON

POST https://mutuo.boracrm.app/api/cotacoes_tipos_veiculos
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{ "nome": "Caminhão", "ativo": true }

JSON

{ "status": true, "record_id": 3 }

PUT/api/cotacoes_tipos_veiculos/{id}Atualiza tipo›

Requisição

Resposta 200

HTTP + JSON

PUT https://mutuo.boracrm.app/api/cotacoes_tipos_veiculos/3
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{ "ativo": false }

JSON

{ "status": true, "record_id": 3 }

DELETE/api/delete/cotacoes_tipos_veiculos/{id}Exclui tipo›

Requisição

✅ Resposta 200

HTTP

DELETE https://mutuo.boracrm.app/api/delete/cotacoes_tipos_veiculos/3
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

{ "status": true, "message": "Tipo excluído." }

Cotações

Franquias `/api/cotacoes_franquias`

Valores de franquia (participação do segurado) vinculados a produtos.

GET/api/cotacoes_franquiasLista todas as franquias›

Requisição

Resposta 200

HTTP

GET https://mutuo.boracrm.app/api/cotacoes_franquias
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

[{ "id": 1, "produto_id": 7, "nome": "Franquia Reduzida", "valor": "1500.00", "ativo": true }]

POST/api/cotacoes_franquiasCria franquia›

Requisição

✅ Resposta 200

HTTP + JSON

POST https://mutuo.boracrm.app/api/cotacoes_franquias
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{ "produto_id": 7, "nome": "Franquia Reduzida", "valor": 1500.00, "ativo": true }

JSON

{ "status": true, "record_id": 1 }

PUT/api/cotacoes_franquias/{id}Atualiza franquia›

Requisição

Resposta 200

HTTP + JSON

PUT https://mutuo.boracrm.app/api/cotacoes_franquias/1
authtoken: eyJhbGciOiJIUzI1NiIsInR5...
Content-Type: application/json

{ "valor": 1800.00 }

JSON

{ "status": true, "record_id": 1 }

DELETE/api/delete/cotacoes_franquias/{id}Exclui franquia›

Requisição

✅ Resposta 200

HTTP

DELETE https://mutuo.boracrm.app/api/delete/cotacoes_franquias/1
authtoken: eyJhbGciOiJIUzI1NiIsInR5...

JSON

{ "status": true, "message": "Franquia excluída." }

API Externa

Placa Fipe — Consulta por Placa `api.placafipe.com.br`

API externa paga. Retorna dados do veículo (marca, modelo, ano, valor FIPE) a partir da placa. Requer token de acesso próprio da PlacaFipe.

⚠️

Esta é uma API de terceiro paga. O token abaixo é de uso exclusivo do Grupo Mútuo e não deve ser compartilhado externamente.

POST/consultarConsulta veículo por placa›

Requisição

✅ Resposta 200

❌ Resposta 404

HTTP + JSON

POST https://api.placafipe.com.br/consultar
Content-Type: application/json
Authorization: Bearer SEU_TOKEN_PLACAFIPE

{
  "placa": "ABC1D23"
}

JSON

{
  "placa": "ABC1D23",
  "marca": "TOYOTA",
  "modelo": "COROLLA XEI 2.0 FLEX 16V AUT.",
  "ano": "2021/2021",
  "anoModelo": 2021,
  "codigoFipe": "005340-9",
  "valorFipe": "R$ 118.800,00",
  "combustivel": "Álcool/Gasolina",
  "municipio": "São Paulo",
  "uf": "SP"
}

JSON

{ "erro": "Placa não encontrada na base de dados." }

API Externa

Placa Fipe — Catálogo `api.placafipe.com.br`

Endpoints auxiliares para listar marcas e modelos disponíveis no catálogo PlacaFipe.

GET/marcasLista marcas disponíveis›

Requisição

Resposta 200

HTTP

GET https://api.placafipe.com.br/marcas
Authorization: Bearer SEU_TOKEN_PLACAFIPE

JSON

[
  { "id": 59, "nome": "Toyota" },
  { "id": 23, "nome": "Honda" }
]

GET/modelos/{marca_id}Lista modelos de uma marca›

Requisição

Resposta 200

HTTP

GET https://api.placafipe.com.br/modelos/59
Authorization: Bearer SEU_TOKEN_PLACAFIPE

JSON

[
  { "id": 1221, "nome": "COROLLA XEI 2.0 FLEX 16V AUT." },
  { "id": 1222, "nome": "COROLLA ALTIS 2.0 FLEX 16V AUT." }
]

API Externa

FIPE Pública — Tabela de Referência `veiculos.fipe.org.br`

API pública da FIPE. Não requer autenticação, mas exige headers específicos de origem para funcionar corretamente.

ℹ️

Envie sempre os headers Origin, Referer e X-Requested-With conforme o exemplo, caso contrário a API retorna erro 403.

POST/api/fipe/ConsultarTabelaDeReferenciaLista tabelas de referência FIPE›

Requisição

Resposta 200

HTTP

POST https://veiculos.fipe.org.br/api/veiculos/ConsultarTabelaDeReferencia
Content-Type: application/x-www-form-urlencoded
Origin: https://veiculos.fipe.org.br
Referer: https://veiculos.fipe.org.br/
X-Requested-With: XMLHttpRequest

(corpo vazio)

JSON

[
  { "Codigo": 316, "Mes": "julho/2026" },
  { "Codigo": 315, "Mes": "junho/2026" }
]

API Externa

FIPE Pública — Marcas e Modelos `veiculos.fipe.org.br`

Consulta marcas e modelos disponíveis na tabela FIPE para um tipo de veículo e tabela de referência.

POST/api/fipe/ConsultarMarcasLista marcas por tipo de veículo›

Requisição

Resposta 200

HTTP

POST https://veiculos.fipe.org.br/api/veiculos/ConsultarMarcas
Content-Type: application/x-www-form-urlencoded
Origin: https://veiculos.fipe.org.br
Referer: https://veiculos.fipe.org.br/
X-Requested-With: XMLHttpRequest

codigoTabelaReferencia=316&codigoTipoVeiculo=1

JSON

[
  { "Label": "Toyota", "Value": "59" },
  { "Label": "Honda", "Value": "23" }
]

POST/api/fipe/ConsultarModelosLista modelos de uma marca›

Requisição

Resposta 200

HTTP

POST https://veiculos.fipe.org.br/api/veiculos/ConsultarModelos
Content-Type: application/x-www-form-urlencoded
Origin: https://veiculos.fipe.org.br
Referer: https://veiculos.fipe.org.br/
X-Requested-With: XMLHttpRequest

codigoTabelaReferencia=316&codigoTipoVeiculo=1&codigoMarca=59

JSON

{
  "Modelos": [
    { "Label": "COROLLA XEI 2.0 FLEX 16V AUT.", "Value": 1221 }
  ],
  "Anos": [
    { "Label": "2021 Gasolina", "Value": "2021-1" }
  ]
}

API Externa

FIPE Pública — Anos e Valor Final `veiculos.fipe.org.br`

Consulta os anos disponíveis para um modelo e obtém o valor FIPE final para uma combinação específica.

POST/api/fipe/ConsultarAnoModeloLista anos disponíveis para um modelo›

Requisição

Resposta 200

HTTP

POST https://veiculos.fipe.org.br/api/veiculos/ConsultarAnoModelo
Content-Type: application/x-www-form-urlencoded
Origin: https://veiculos.fipe.org.br
Referer: https://veiculos.fipe.org.br/
X-Requested-With: XMLHttpRequest

codigoTabelaReferencia=316&codigoTipoVeiculo=1&codigoMarca=59&codigoModelo=1221

JSON

[
  { "Label": "2021 Gasolina", "Value": "2021-1" },
  { "Label": "2020 Gasolina", "Value": "2020-1" }
]

POST/api/fipe/ConsultarValorComTodosParametrosValor FIPE final›

Requisição

Resposta 200

HTTP

POST https://veiculos.fipe.org.br/api/veiculos/ConsultarValorComTodosParametros
Content-Type: application/x-www-form-urlencoded
Origin: https://veiculos.fipe.org.br
Referer: https://veiculos.fipe.org.br/
X-Requested-With: XMLHttpRequest

codigoTabelaReferencia=316&codigoTipoVeiculo=1&codigoMarca=59&codigoModelo=1221&ano=2021-1&codigoTipoCombustivel=1&anoModelo=2021&tipoConsulta=tradicional

JSON

{
  "TipoVeiculo": 1,
  "Valor": "R$ 118.800,00",
  "Marca": "Toyota",
  "Modelo": "COROLLA XEI 2.0 FLEX 16V AUT.",
  "AnoModelo": 2021,
  "Combustivel": "Gasolina",
  "CodigoFipe": "005340-9",
  "MesReferencia": "julho de 2026"
}

API Externa

SGA Hinova — Autenticação `api.hinova.com.br/api/sga/v2`

A API SGA usa dois níveis de autenticação: um Bearer Token fixo (credencial do sistema) mais um token_usuario obtido por login.

⚠️

O token_usuario expira. Armazene-o em sessão e renove quando receber erro 401.

POST/usuario/autenticarObtém token_usuario›

Requisição

✅ Resposta 200

❌ Resposta 401

HTTP + JSON

POST https://api.hinova.com.br/api/sga/v2/usuario/autenticar
Content-Type: application/json
Authorization: Bearer TOKEN_SISTEMA_FIXO

{
  "usuario": "login_do_usuario",
  "senha":   "senha_do_usuario"
}

JSON

{
  "token_usuario": "eyJhbGciOiJIUzI1NiJ9.eyJ1c3VhcmlvIjoibG9naW5f...",
  "expiracao": "2026-07-02T18:00:00"
}

JSON

{ "mensagem": "Credenciais inválidas.", "codigo": 401 }

API Externa

SGA Hinova — Associado `api.hinova.com.br/api/sga/v2`

Cadastro e consulta de associados no sistema SGA. Todos os endpoints requerem Bearer Token fixo + header token_usuario.

POST/associadoCadastra novo associado›

Requisição

✅ Resposta 200

HTTP + JSON

POST https://api.hinova.com.br/api/sga/v2/associado
Content-Type: application/json
Authorization: Bearer TOKEN_SISTEMA_FIXO
token_usuario: eyJhbGciOiJIUzI1NiJ9...

{
  "nome":             "Carlos Eduardo Silva",
  "cpf":              "12345678900",
  "data_nascimento":  "1985-03-22",
  "sexo":             "M",
  "email":            "carlos.silva@gmail.com",
  "celular":          "11999887766",
  "cep":              "01310100",
  "logradouro":       "Av. Paulista",
  "numero":           "1234",
  "bairro":           "Bela Vista",
  "cidade":           "São Paulo",
  "uf":               "SP"
}

JSON

{
  "codigo_associado": "ASS-00847",
  "mensagem": "Associado cadastrado com sucesso."
}

GET/associado/{cpf}Consulta associado por CPF›

Requisição

Resposta 200

HTTP

GET https://api.hinova.com.br/api/sga/v2/associado/12345678900
Authorization: Bearer TOKEN_SISTEMA_FIXO
token_usuario: eyJhbGciOiJIUzI1NiJ9...

JSON

{
  "codigo_associado": "ASS-00847",
  "nome": "Carlos Eduardo Silva",
  "cpf": "12345678900",
  "email": "carlos.silva@gmail.com",
  "situacao": "ATIVO"
}

API Externa

SGA Hinova — Voluntário `api.hinova.com.br/api/sga/v2`

Consulta dados de usuário staff (voluntário/colaborador) pelo login no SGA.

GET/usuario/voluntario/{login}Consulta voluntário por login›

Requisição

Resposta 200

HTTP

GET https://api.hinova.com.br/api/sga/v2/usuario/voluntario/carlos.silva
Authorization: Bearer TOKEN_SISTEMA_FIXO
token_usuario: eyJhbGciOiJIUzI1NiJ9...

JSON

{
  "codigo_voluntario": "VOL-0042",
  "nome": "Carlos Eduardo Silva",
  "login": "carlos.silva",
  "perfil": "CONSULTOR",
  "situacao": "ATIVO"
}

API Externa

SGA Hinova — Veículo `api.hinova.com.br/api/sga/v2`

Cadastro e consulta de veículos associados a um associado no SGA.

POST/veiculoCadastra veículo›

Requisição

✅ Resposta 200

HTTP + JSON

POST https://api.hinova.com.br/api/sga/v2/veiculo
Content-Type: application/json
Authorization: Bearer TOKEN_SISTEMA_FIXO
token_usuario: eyJhbGciOiJIUzI1NiJ9...

{
  "codigo_associado": "ASS-00847",
  "placa":             "ABC1D23",
  "renavam":           "01234567890",
  "marca":             "TOYOTA",
  "modelo":            "COROLLA XEI 2.0 FLEX 16V AUT.",
  "ano_fabricacao":    2021,
  "ano_modelo":        2021,
  "codigo_fipe":       "005340-9",
  "valor_fipe":        118800.00,
  "cor":               "Prata",
  "combustivel":       "FLEX"
}

JSON

{
  "codigo_veiculo": "VEI-01293",
  "mensagem": "Veículo cadastrado com sucesso."
}

GET/veiculo/{placa}Consulta veículo por placa›

Requisição

Resposta 200

HTTP

GET https://api.hinova.com.br/api/sga/v2/veiculo/ABC1D23
Authorization: Bearer TOKEN_SISTEMA_FIXO
token_usuario: eyJhbGciOiJIUzI1NiJ9...

JSON

{
  "codigo_veiculo": "VEI-01293",
  "codigo_associado": "ASS-00847",
  "placa": "ABC1D23",
  "marca": "TOYOTA",
  "modelo": "COROLLA XEI 2.0 FLEX 16V AUT.",
  "ano_modelo": 2021,
  "valor_fipe": "118800.00",
  "situacao": "ATIVO"
}

Grupo Mútuo — API REST

Como funciona a autenticação

Como usar o token

Exemplo com cURL

Permissões por recurso

Capabilities disponíveis

Recursos e suas capabilities

Códigos de resposta

Estrutura padrão de sucesso

Estrutura padrão de erro

Leads /api/leads

Clientes /api/customers

Cotações Veiculares /api/cotacoes_veiculares

Produtos /api/cotacoes_produtos

Itens /api/cotacoes_itens

Combos /api/cotacoes_combos

Tipos de Veículo /api/cotacoes_tipos_veiculos

Franquias /api/cotacoes_franquias

Placa Fipe — Consulta por Placa api.placafipe.com.br

Placa Fipe — Catálogo api.placafipe.com.br

FIPE Pública — Tabela de Referência veiculos.fipe.org.br

FIPE Pública — Marcas e Modelos veiculos.fipe.org.br

FIPE Pública — Anos e Valor Final veiculos.fipe.org.br

SGA Hinova — Autenticação api.hinova.com.br/api/sga/v2

SGA Hinova — Associado api.hinova.com.br/api/sga/v2

SGA Hinova — Voluntário api.hinova.com.br/api/sga/v2

SGA Hinova — Veículo api.hinova.com.br/api/sga/v2

Leads `/api/leads`

Clientes `/api/customers`

Cotações Veiculares `/api/cotacoes_veiculares`

Produtos `/api/cotacoes_produtos`

Itens `/api/cotacoes_itens`

Combos `/api/cotacoes_combos`

Tipos de Veículo `/api/cotacoes_tipos_veiculos`

Franquias `/api/cotacoes_franquias`

Placa Fipe — Consulta por Placa `api.placafipe.com.br`

Placa Fipe — Catálogo `api.placafipe.com.br`

FIPE Pública — Tabela de Referência `veiculos.fipe.org.br`

FIPE Pública — Marcas e Modelos `veiculos.fipe.org.br`

FIPE Pública — Anos e Valor Final `veiculos.fipe.org.br`

SGA Hinova — Autenticação `api.hinova.com.br/api/sga/v2`

SGA Hinova — Associado `api.hinova.com.br/api/sga/v2`

SGA Hinova — Voluntário `api.hinova.com.br/api/sga/v2`

SGA Hinova — Veículo `api.hinova.com.br/api/sga/v2`