Veículos · API Hooked

Visão Geral

O módulo Veículos gerencia o cadastro de veículos utilizados para transporte de mercadorias. Essas informações são utilizadas no preenchimento de documentos fiscais como MDF-e (Manifesto Eletrônico de Documentos Fiscais) e CT-e (Conhecimento de Transporte Eletrônico).

Endpoints

GET /api/veiculos

Descrição: Lista todos os veículos cadastrados com suporte a paginação e filtros. Autenticação: Obrigatória

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
pagina	integer	Não	Número da página (padrão: 1)
quantidade	integer	Não	Itens por página (padrão: 20)
placa	string	Não	Filtrar por placa do veículo
ativo	boolean	Não	Filtrar por status ativo/inativo

Resposta de Sucesso

{
  "dados": [
    {
      "id": "uuid",
      "placa": "ABC-1234",
      "renavam": "12345678901",
      "tipo": "caminhao",
      "marca": "Mercedes-Benz",
      "modelo": "Actros",
      "anoFabricacao": 2022,
      "uf": "SP",
      "ativo": true
    }
  ],
  "total": 5,
  "pagina": 1,
  "quantidade": 20
}

Códigos de Erro Comuns

Código	Descrição
401	Não autorizado
500	Erro interno do servidor

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/veiculos" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/veiculos', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/veiculos',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/veiculos", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/veiculos');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/veiculos",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/veiculos",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

POST /api/veiculos

Descrição: Cadastra um novo veículo no sistema. Autenticação: Obrigatória

Corpo da Requisição (Request Body)

{
  "placa": "XYZ-5678",
  "renavam": "98765432100",
  "tipo": "van",
  "marca": "Fiat",
  "modelo": "Ducato",
  "anoFabricacao": 2023,
  "uf": "SP",
  "tara": 2500,
  "capacidadeKg": 1500,
  "capacidadeM3": 10,
  "proprietarioId": "uuid",
  "ativo": true
}

Resposta de Sucesso

{
  "id": "uuid",
  "placa": "XYZ-5678",
  "tipo": "van",
  "ativo": true
}

Códigos de Erro Comuns

Código	Descrição
400	Dados inválidos
401	Não autorizado
409	Placa já cadastrada

Exemplos de Código

cURL

curl -X POST "https://api.app.hooked.com.br/api/veiculos" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"placa":"XYZ-5678","renavam":"98765432100","tipo":"van","marca":"Fiat","modelo":"Ducato","anoFabricacao":2023,"uf":"SP","tara":2500,"capacidadeKg":1500,"capacidadeM3":10,"proprietarioId":"uuid","ativo":true}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/veiculos', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "placa": "XYZ-5678",
  "renavam": "98765432100",
  "tipo": "van",
  "marca": "Fiat",
  "modelo": "Ducato",
  "anoFabricacao": 2023,
  "uf": "SP",
  "tara": 2500,
  "capacidadeKg": 1500,
  "capacidadeM3": 10,
  "proprietarioId": "uuid",
  "ativo": true
})
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/veiculos',
    headers={'Authorization': 'Bearer {token}'},
    json={'placa': 'XYZ-5678', 'renavam': '98765432100', 'tipo': 'van', 'marca': 'Fiat', 'modelo': 'Ducato', 'anoFabricacao': 2023, 'uf': 'SP', 'tara': 2500, 'capacidadeKg': 1500, 'capacidadeM3': 10, 'proprietarioId': 'uuid', 'ativo': True}
).json()

import (
    "bytes"
    "net/http"
)

payload := []byte(`{"placa":"XYZ-5678","renavam":"98765432100","tipo":"van","marca":"Fiat","modelo":"Ducato","anoFabricacao":2023,"uf":"SP","tara":2500,"capacidadeKg":1500,"capacidadeM3":10,"proprietarioId":"uuid","ativo":true}`)
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/veiculos", bytes.NewBuffer(payload))
req.Header.Set("Authorization", "Bearer {token}")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/veiculos');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'placa' => 'XYZ-5678',
        'renavam' => '98765432100',
        'tipo' => 'van',
        'marca' => 'Fiat',
        'modelo' => 'Ducato',
        'anoFabricacao' => 2023,
        'uf' => 'SP',
        'tara' => 2500,
        'capacidadeKg' => 1500,
        'capacidadeM3' => 10,
        'proprietarioId' => 'uuid',
        'ativo' => true
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/veiculos",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/veiculos",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"placa\":\"XYZ-5678\",\"renavam\":\"98765432100\",\"tipo\":\"van\",\"marca\":\"Fiat\",\"modelo\":\"Ducato\",\"anoFabricacao\":2023,\"uf\":\"SP\",\"tara\":2500,\"capacidadeKg\":1500,\"capacidadeM3\":10,\"proprietarioId\":\"uuid\",\"ativo\":true}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

GET /api/veiculos/{id}

Descrição: Retorna os detalhes de um veículo pelo seu identificador único. Autenticação: Obrigatória

Parâmetros de Path

Parâmetro	Tipo	Obrigatório	Descrição
id	string (uuid)	Sim	Identificador único do veículo

Resposta de Sucesso

{
  "id": "uuid",
  "placa": "XYZ-5678",
  "renavam": "98765432100",
  "tipo": "van",
  "marca": "Fiat",
  "modelo": "Ducato",
  "anoFabricacao": 2023,
  "uf": "SP",
  "tara": 2500,
  "capacidadeKg": 1500,
  "capacidadeM3": 10,
  "proprietario": "Transportadora ABC Ltda",
  "ativo": true
}

Códigos de Erro Comuns

Código	Descrição
401	Não autorizado
404	Veículo não encontrado

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/veiculos/{id}" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/veiculos/{id}', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/veiculos/{id}',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/veiculos/{id}", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/veiculos/{id}');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/veiculos/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/veiculos/{id}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

PUT /api/veiculos/{id}

Descrição: Atualiza os dados de um veículo existente. Autenticação: Obrigatória

Parâmetros de Path

Parâmetro	Tipo	Obrigatório	Descrição
id	string (uuid)	Sim	Identificador único do veículo

Corpo da Requisição (Request Body)

{
  "capacidadeKg": 2000,
  "ativo": true
}

Resposta de Sucesso

{
  "id": "uuid",
  "placa": "XYZ-5678",
  "capacidadeKg": 2000,
  "ativo": true
}

Códigos de Erro Comuns

Código	Descrição
400	Dados inválidos
401	Não autorizado
404	Veículo não encontrado

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/veiculos/{id}" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"capacidadeKg":2000,"ativo":true}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/veiculos/{id}', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "capacidadeKg": 2000,
  "ativo": true
})
});
const data = await response.json();

Python

import requests

data = requests.put(
    'https://api.app.hooked.com.br/api/veiculos/{id}',
    headers={'Authorization': 'Bearer {token}'},
    json={'capacidadeKg': 2000, 'ativo': True}
).json()

import (
    "bytes"
    "net/http"
)

payload := []byte(`{"capacidadeKg":2000,"ativo":true}`)
req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/veiculos/{id}", bytes.NewBuffer(payload))
req.Header.Set("Authorization", "Bearer {token}")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/veiculos/{id}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'PUT',
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'capacidadeKg' => 2000,
        'ativo' => true
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — PUT /api/veiculos/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/veiculos/{id}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"capacidadeKg\":2000,\"ativo\":true}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

DELETE /api/veiculos/{id}

Descrição: Remove um veículo do sistema pelo seu identificador. Autenticação: Obrigatória

Parâmetros de Path

Parâmetro	Tipo	Obrigatório	Descrição
id	string (uuid)	Sim	Identificador único do veículo

Resposta de Sucesso

{
  "mensagem": "Veículo removido com sucesso"
}

Códigos de Erro Comuns

Código	Descrição
401	Não autorizado
404	Veículo não encontrado
409	Veículo vinculado a manifestos ou transportes

Exemplos de Código

cURL

curl -X DELETE "https://api.app.hooked.com.br/api/veiculos/{id}" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/veiculos/{id}', {
  method: 'DELETE',
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.delete(
    'https://api.app.hooked.com.br/api/veiculos/{id}',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("DELETE", "https://api.app.hooked.com.br/api/veiculos/{id}", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/veiculos/{id}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'DELETE',
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — DELETE /api/veiculos/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "DELETE",
        "url": "https://api.app.hooked.com.br/api/veiculos/{id}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}