API e tokens

Integrações externas via API REST.

Visão geral

A plataforma possui API auxiliar NestJS para automações e integrações. Endpoints usam prefixo /v1/.

Documentação interativa (OpenAPI/Scalar) disponível no servidor da API em /reference.

Autenticação

Todas as requisições exigem header:

X-API-Key: SUA_CHAVE

Gerar token

Configurações → API tokens

1. Crie token com nome descritivo
2. Copie a chave (exibida uma vez)
3. Use em integrações

Endpoints principais

Recurso	Rotas
Tarefas	GET/POST/PUT/DELETE /v1/tasks
Projetos	/v1/projects
Clientes	/v1/clients
Propostas	/v1/proposals
Faturas	/v1/invoices
Chamados	/v1/tickets
Dashboard	GET /v1/dashboard/summary
Health	GET /v1/health

Exemplo

curl -X GET "https://api.exemplo.com/v1/tasks?done=false&limit=20" \
  -H "X-API-Key: SUA_CHAVE"

Listagem de tarefas finalizadas

GET /v1/tasks?done=true

Tabelas genéricas

GET /v1/tables/{nome} — leitura de tabelas na whitelist (ex.: task_templates, help_articles).

Segurança

• Rotacione tokens periodicamente
• Não commite chaves em repositórios
• Use HTTPS em produção

Próximo passo

FAQ