NooviFlow API
API para gestao financeira e CRM — clientes, transacoes, contratos, faturas e automacoes de cobranca.
Base URL
Primeiros Passos
~5 min- 1Fazer login e obter seu JWT Token
- 2Fazer sua primeira requisicao (ver Quick Start abaixo)
- 3Testar autenticacao com GET /clients
- 4Explorar os endpoints na Referencia API
Quick Start & Autenticacao
Faca sua primeira requisicao listando clientes da sua conta:
curl -X GET \
"https://flow.seudominio.com/api/v1/clients" \
-H "Authorization: Bearer YOUR_JWT_TOKEN" \
-H "Content-Type: application/json"Autenticacao
A NooviFlow API utiliza JWT (JSON Web Tokens) para autenticacao. Envie o header Authorization: Bearer TOKEN em todas as requisicoes. Consulte o guia de autenticacao para mais detalhes.
Endpoints
Ver referencia completaClientes
Gerenciar cadastro de clientes e empresas
/api/v1/clientsListar todos os clientes
/api/v1/clientsCriar um novo cliente
/api/v1/clients/{id}Obter detalhes do cliente
/api/v1/clients/{id}Atualizar um cliente
Transacoes
Controle de transacoes financeiras
/api/v1/transactionsListar transacoes
/api/v1/transactionsCriar uma transacao
/api/v1/transactions/{id}Obter detalhes da transacao
Contratos
Gerenciar contratos e assinaturas
/api/v1/contractsListar contratos
/api/v1/contractsCriar um contrato
/api/v1/contracts/{id}Atualizar um contrato
/api/v1/contracts/{id}Cancelar um contrato
Faturas
Emissao e controle de faturas
/api/v1/invoicesListar faturas
/api/v1/invoicesEmitir uma fatura
/api/v1/invoices/{id}/mark-paidMarcar fatura como paga
Automacoes
Regras automaticas de cobranca e notificacao
/api/v1/automationsListar automacoes
/api/v1/automationsCriar automacao
/api/v1/automations/{id}Atualizar automacao
Exemplo Completo
Crie um cliente, emita uma fatura e registre o pagamento em 3 passos:
const API = "https://flow.seudominio.com/api/v1";
const TOKEN = "YOUR_JWT_TOKEN";
const headers = { "Authorization": `Bearer ${TOKEN}`, "Content-Type": "application/json" };
// 1. Criar cliente
const client = await fetch(`${API}/clients`, {
method: "POST",
headers,
body: JSON.stringify({
name: "Empresa ABC Ltda",
email: "contato@empresaabc.com.br",
document: "12.345.678/0001-90",
}),
}).then(r => r.json());
// 2. Emitir fatura
const invoice = await fetch(`${API}/invoices`, {
method: "POST",
headers,
body: JSON.stringify({
client_id: client.id,
amount: 1500.00,
due_date: "2026-03-15",
description: "Servico de consultoria - Marco/2026",
}),
}).then(r => r.json());
// 3. Registrar pagamento
await fetch(`${API}/invoices/${invoice.id}/mark-paid`, {
method: "PATCH",
headers,
});
console.log("Fatura paga:", invoice.id);Casos de Uso
Cobranca Recorrente
Automatize emissao de faturas e acompanhe pagamentos recorrentes.
Gestao de Clientes e Contratos
Cadastre clientes, gerencie contratos e acompanhe o ciclo de vida.
Automacao Financeira
Crie regras automaticas de cobranca, notificacao e conciliacao.
Erros Comuns
401Unauthorized
Causa: JWT token ausente, invalido ou expirado (expira em 24h).
Solucao: Faca uma nova requisicao de login para obter um token atualizado.
403Forbidden
Causa: Token valido mas sem permissao para o recurso ou tenant.
Solucao: Verifique se o usuario tem acesso ao tenant e recurso solicitado.
422Unprocessable Entity
Causa: Dados invalidos (ex: email duplicado, campo obrigatorio ausente).
Solucao: Revise o body e verifique campos obrigatorios e validacoes do schema.
429Too Many Requests
Causa: Limite de requisicoes excedido (200 req/min).
Solucao: Implemente backoff exponencial e respeite o header Retry-After.
Problema persiste? Entre em contato com o suporte
Referencia Completa
Explore todos os endpoints com exemplos, schemas e detalhes de parametros.
Abrir Referencia API