API REST v1

Integre sistemas externos — contabilidade terceirizada, e-commerce e bancos — aos dados da sua empresa no KORVIX. Todos os dados retornados são isolados pela empresa dona da chave.

URL base: https://korvixerp.lovable.app/api/public/v1

Autenticação

Gere uma chave em Administração › Chaves de API e envie no headerX-API-Key. A chave completa é exibida apenas uma vez; guarde-a com segurança e revogue-a se houver suspeita de vazamento.

curl https://korvixerp.lovable.app/api/public/v1/products \
  -H "X-API-Key: kvx_sua_chave_aqui"

Recursos de leitura (GET)

Endpoint	Descrição
/v1/products	Produtos e saldos de estoque
/v1/suppliers	Fornecedores
/v1/customers	Clientes
/v1/stock_movements	Movimentações de estoque
/v1/sales	Vendas
/v1/accounts_receivable	Contas a receber
/v1/accounts_payable	Contas a pagar
/v1/fiscal_invoices	Notas fiscais
/v1/production_orders	Ordens de produção
/v1/purchase_orders	Pedidos de compra

Use /v1/{recurso}/{id} para buscar um registro específico.

Paginação e filtros

Parâmetros: limit (padrão 50, máx. 200),offset eupdated_since (ISO 8601) para sincronização incremental.

GET /api/public/v1/sales?limit=100&offset=0&updated_since=2026-01-01T00:00:00Z

{
  "data": [ /* registros */ ],
  "pagination": { "limit": 100, "offset": 0, "total": 842 }
}

Escrita (POST)

Disponível apenas para chaves com escopo write, nos recursos: customerssuppliersproductsstock_movements

curl -X POST https://korvixerp.lovable.app/api/public/v1/customers \
  -H "X-API-Key: kvx_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{"name":"Cliente Exemplo Ltda","doc":"12345678000199","email":"contato@exemplo.com"}'

Os campos id, tenant_id e datas de controle são ignorados no corpo e preenchidos automaticamente.

Códigos de resposta

200 / 201 — sucesso
400 — corpo ou parâmetros inválidos
401 — chave ausente, inválida, expirada ou revogada
403 — chave sem permissão de escrita
404 — recurso ou registro inexistente