Documentação da API

Requisitos

Plano Business ou Enterprise
Chave de API gerada no painel Configurações → Integrações
Enviar a chave no header x-api-key de todas as requisições

Autenticação

Todas as requisições devem incluir o header x-api-key com a sua chave de API.

x-api-key: vk_a1b2c3d4e5f6...

Content-Type: application/json

Base URL

https://api-rest-node.vailogix.com.br/api

Todas as rotas da API pública começam com /api.

Endpoints

Clientes

POST/api/clients

GET/api/clients

Cria e lista clientes da transportadora.

Veículos

POST/api/vehicles

GET/api/vehicles

Cria e lista veículos da frota.

Motoristas

POST/api/drivers

GET/api/drivers

Cria e lista motoristas. Será necessário login manual após criação.

Serviços / Configurações

POST/api/service-configs

GET/api/service-configs

Cria e lista configurações de serviço (tipos de entrega e preços).

Rotas de Entrega

POST/api/routes

GET/api/routes

Cria e lista rotas de entrega. Ao criar, o endereço é geocodificado automaticamente (lat/lng). driver_id e service_id são opcionais.

Exemplos

Criar Cliente

curl -X POST https://api-rest-node.vailogix.com.br/api/clients \
  -H "x-api-key: SUA_CHAVE_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "full_name": "João Silva",
    "trade_name": "Silva Transportes",
    "document_number": "12345678901",
    "document_type": "PF",
    "phone": "(11) 98765-4321",
    "email": "joao@email.com",
    "address_street": "Rua das Flores",
    "address_number": "123",
    "address_city": "São Paulo",
    "address_state": "SP",
    "address_zip": "01001000"
  }'

Criar Configuração de Serviço

curl -X POST https://api-rest-node.vailogix.com.br/api/service-configs \
  -H "x-api-key: SUA_CHAVE_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Entrega Expressa",
    "description": "Entrega no mesmo dia",
    "pricing_method": "fixed",
    "fixed_price": 45.50
  }'

Listar Configurações de Serviço

curl -X GET https://api-rest-node.vailogix.com.br/api/service-configs \
  -H "x-api-key: SUA_CHAVE_AQUI"

Criar Rota de Entrega (geocoding automático)

curl -X POST https://api-rest-node.vailogix.com.br/api/routes \
  -H "x-api-key: SUA_CHAVE_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "UUID_DO_CLIENTE",
    "driver_id": "UUID_DO_MOTORISTA_OPCIONAL",
    "service_id": "UUID_DO_SERVICO_OPCIONAL",
    "dest_street": "Avenida Paulista",
    "dest_number": "1000",
    "dest_complement": "Apto 42",
    "dest_district": "Bela Vista",
    "dest_city": "São Paulo",
    "dest_state": "SP",
    "dest_zip": "01310000",
    "notes": "Entrega urgente até 18h"
  }'

Retorno (geocoding automático):
{
  "success": true,
  "data": {
    "id": "uuid-da-rota"
  },
  "geocoded": {
    "lat": -23.5505,
    "lng": -46.6333
  }
}

Listar Rotas

curl -X GET https://api-rest-node.vailogix.com.br/api/routes \
  -H "x-api-key: SUA_CHAVE_AQUI"

Planos e Limites

A API respeita os limites do plano. Se o limite for atingido, a API retorna 429 Too Many Requests.

Plano	Motoristas	Entregas/mês	API
Starter	3	200	—
Growth	6	500	—
Business	12	1000	✅
Enterprise	25	25000	✅

Códigos de Erro

401Chave de API inválida ou ausente

404Endpoint não existe

429Limite do plano atingido

500Erro interno do servidor

API REST — VaiLogix