Plataforma para desenvolvedores

Conecte a operação sem perder governança

APIs, webhooks e eventos para integrar a SprintPlatform ao ecossistema da sua empresa com isolamento por workspace, escopos mínimos e trilha de auditoria.

Solicitar acesso à API Explorar endpoints
Criar um lead
POST /api/public/v1/leads
Authorization: Bearer ••••••••
Content-Type: application/json

{
  "name": "Empresa Horizonte",
  "source": "integration",
  "workspace_id": "ws_••••"
}

Integrações seguras

Tudo para construir sobre o Business Core

Acesso por escopo

Contas de serviço recebem somente as permissões necessárias por módulo e ação.

Webhooks assinados

Eventos verificáveis conectam processos externos com entrega rastreável.

Eventos operacionais

Alterações relevantes alimentam automações e integrações sem consultas repetitivas.

Auditoria completa

Ator, origem, workspace, entidade e resultado permanecem registrados.

API REST

Endpoints por domínio

O catálogo usa os mesmos objetos de negócio da plataforma e respeita o contexto do tenant e do workspace.

crm.read
crm.write
service.read
service.write
finance.read
finance.write
documents.read
documents.write
notes.read
notes.write
analytics.read
automation.execute
GET
/api/public/v1/event-invoices?workspace_id=&event_id=

Lista faturas vinculadas a eventos com valores recebidos · finance.read

POST
/api/public/v1/event-invoices

Cria fatura vinculada ao evento ou registra recebimento (Idempotency-Key) · finance.write

GET
/api/public/v1/note-clips?workspace_id=&url=&preview=1

Web Clipper: checa duplicidade e gera preview seguro da URL (bloqueia redes internas) · notes.read

POST
/api/public/v1/note-clips

Web Clipper (extensões Chrome/Edge/Firefox): cria Smart Note com destino e vínculo; 409 se URL duplicada (force=true para recapturar) · notes.write

GET
/api/public/v1/contacts

Lista contatos do workspace · crm.read

POST
/api/public/v1/leads

Cria lead a partir de origem externa · crm.write

GET
/api/public/v1/tickets

Lista chamados com SLA · service.read

POST
/api/public/v1/tickets

Abre chamado pelo portal externo · service.write

GET
/api/public/v1/invoices

Consulta faturas e situação de pagamento · finance.read

GET
/api/public/v1/documents

Lista documentos do GED autorizados · documents.read

GET
/api/public/v1/kpis

Retorna KPIs governados do workspace · analytics.read

POST
/api/public/v1/automations/{id}/run

Dispara automação por integração · automation.execute

API de faturas de eventos

Conciliação automática com o seu banco

Crie faturas vinculadas a um evento e registre os recebimentos assim que o banco confirmar. Cada pagamento atualiza a fatura, os pedidos ligados a ela, a conciliação e o fluxo de caixa do evento. Use o token de acesso de um usuário do workspace (gestor) no cabeçalho Authorization; as permissões do workspace são aplicadas.

1. Criar fatura vinculada ao evento

POST /api/public/v1/event-invoices
Authorization: Bearer <token>
Content-Type: application/json

{
  "workspace_id": "<uuid>",
  "event_id": "<uuid>",
  "number": "EV-2026-0001",
  "total": 1500.00,
  "issue_date": "2026-10-02",
  "due_date": "2026-10-15",
  "description": "Patrocínio cota prata"
}

→ 201 { "id": "<invoice_id>", "number": "EV-2026-0001" }

2. Registrar recebimento confirmado pelo banco

POST /api/public/v1/event-invoices
Authorization: Bearer <token>
Idempotency-Key: <id-da-transacao-no-banco>
Content-Type: application/json

{
  "workspace_id": "<uuid>",
  "event_id": "<uuid>",
  "invoice_id": "<invoice_id>",
  "amount": 1500.00,
  "method": "pix",
  "paid_at": "2026-10-10T14:30:00-03:00"
}

→ 201 { "id": "<payment_id>", "idempotent": false }
→ 200 { "idempotent": true }  (mesma chave reenviada)

Como integrar o seu banco

  1. Gere a fatura pela API (ou vincule uma existente no Financeiro do evento) e envie o número ao pagador como referência do Pix/boleto.
  2. No retorno do banco (webhook ou leitura de extrato), localize a fatura pela referência e chame o registro de recebimento com o valor efetivamente creditado.
  3. Use o identificador da transação bancária como Idempotency-Key: reenvios não duplicam a baixa.
  4. Valores diferentes do faturado aparecem como divergência na conciliação; faturas sem recebimento após o vencimento aparecem como vencidas.
  5. Consulte GET com workspace_id e event_id para conferir o que já foi conciliado.

Sandbox por workspace

  • Dados isolados
  • Credenciais separadas
  • Simulação antes da produção

Contratos previsíveis

  • Respostas estruturadas
  • Validação de entrada
  • Versionamento controlado

Operação observável

  • Histórico de chamadas
  • Falhas e retentativas
  • Alertas e métricas