Conecte seu sistema
ao Sendero CRM.

Sua primeira consulta

Esta documentação é pública. Para consultar dados, sua aplicação precisa de uma chave emitida por um administrador do CRM.

1. Receba uma credencial

   O administrador abre Cadastros → Integrações, cria uma aplicação e entrega a chave por um canal seguro. Para acesso completo de leitura, use o escopo dados:read.

2. Configure o sistema consumidor

   Guarde CRM_API_KEY no ambiente seguro do seu servidor. Use CRM_BASE_URL com a URL base completa mostrada acima. Não coloque a chave no código do navegador, na URL ou no repositório.

3. Faça uma requisição GET

   Os exemplos consultam a primeira página de créditos e tratam uma resposta recusada. Os arquivos completos para paginação estão disponíveis ao final.

Os exemplos serão carregados com JavaScript.

Exemplos para execução no servidor do consumidor. Nenhuma consulta à API é executada por esta página.

{
  "items": [],
  "pagination": { "limit": 50, "hasMore": false, "nextCursor": null },
  "consultedAt": "2026-10-16T12:00:00.000Z"
}

Autenticação e escopos

Envie a chave em todas as requisições, exclusivamente no cabeçalho Authorization. O consumidor externo não precisa da senha, do cookie ou do CSRF de um usuário do CRM.

Authorization: Bearer SUA_CHAVE
Accept: application/json

Os dados ficam restritos à organização da credencial. Campos técnicos de senhas, sessões e chaves não são disponibilizados. Essa proteção não analisa o conteúdo livre de textos e anexos.

Selecione campos e filtre os dados

Existem duas formas de consultar. Use os recursos amigáveis, como /creditos e /campanhas, ou a consulta universal /dados/{table}, com os nomes de tabela e coluna do catálogo.

Consulte os operadores de cada coluna no catálogo: eq, ne, gt, gte, lt, lte, in, contains ou isNull. SQL, expressões e joins não são aceitos nesses parâmetros.

O UUID do exemplo é ilustrativo. Obtenha o ID real na listagem de créditos. Nos recursos amigáveis, os campos usam camelCase; na consulta universal, geralmente snake_case.

Percorra todas as páginas

O padrão é 50 registros por página. A listagem /creditos aceita até 1.000: envie limit=1000 para reduzir a quantidade de chamadas na carga completa. Os demais recursos, consultas universais e acompanhamentos mantêm até 200 registros por página; resumos mantêm até 200 grupos. Para ler o conjunto completo, continue enquanto pagination.hasMore for verdadeiro.

1. Leia items e processe os registros.
2. Use pagination.nextCursor como cursor na próxima chamada.
3. Mantenha o mesmo recurso, campos, filtros e limite. Não edite o cursor.
4. Encerre quando hasMore for false.

As páginas consultam o estado disponível em cada requisição; uma sequência de páginas não é um snapshot único. Preserve valores monetários, documentos e identificadores legados como texto para manter precisão e zeros iniciais.

Baixar exemplo de paginação em Node.js / Baixar exemplo em Python

Financeiro completo e resumos

Use as tabelas abaixo para consultar os valores armazenados. Relacione os registros por prospect_id e o crédito à campanha por campaign_id.

A rota /creditos/{id}/financeiro reúne movimentos paginados e um summary com os valores, detalhes e estado de abertura. Não some automaticamente valores legados, honorários, saldos de abertura e movimentos: existem regras de reconciliação. Não some novamente os totais aos movimentos.

Calcule contagens e somas no servidor

Use /dados/{table}/resumo com groupBy (até três campos) e metrics (até dez métricas). Funções: count, sum, avg, min e max.

Resumos não têm cursor. O limite é de 200 grupos; acima disso, a API responde 422 AGGREGATION_TOO_LARGE sem retornar um resumo parcial. Restrinja a consulta com filtros. Contagens, somas e médias são strings. Para reproduzir relatórios calculados do CRM, aplique os mesmos critérios e fórmulas aos dados.

Acompanhe atualizações com SSE

Abra /acompanhar/{table} ou /acompanhar/{table}/resumo com dados:read, os mesmos parâmetros da consulta e Accept: text/event-stream.

event: snapshot
data: {"result":{"items":[],"pagination":{"limit":50,"hasMore":false,"nextCursor":null},"consultedAt":"2026-10-16T12:00:00.000Z"},"refreshedAt":"2026-10-16T12:00:00.000Z"}

Alterações salvas provocam novas consultas, agrupadas com intervalo mínimo de dois segundos mais o tempo de execução. Há uma verificação a cada 60 segundos. Uma página acompanhada não representa todos os registros da tabela.

Use fetch com o cabeçalho Bearer. Não coloque a chave em parâmetros de EventSource. Trate o evento error, faça reconexão limitada para falhas transitórias e interrompa em credencial inválida ou permissão insuficiente.

Baixar consumidor Node.js com parser SSE e reconexão

Para sincronização completa, reconcilie também exclusões e tabelas relacionadas. prospects.updated_at não é um marcador universal de mudanças em contatos, pagamentos e demais registros.

Baixe arquivos de documentos

Localize o ID e os metadados nas tabelas prospect_documents ou campaign_documents. Depois, baixe o arquivo com dados:read:

O ID da rota é o ID do documento, não o ID do crédito ou da campanha. A resposta é binária, com Content-Disposition: attachment; não tente interpretá-la como JSON.

Arquivos preservados com exclusão lógica continuam disponíveis, respeitando a organização. Um registro de documento gerado não garante um arquivo disponível por essas duas rotas.

Endpoints

Caminhos a partir do endereço do CRM; já incluem /api/integracoes/v1. Expanda um endpoint para ver parâmetros, campos, resposta e observações.

Carregando referência…

Não foi possível carregar a referência. Tentar novamente ou abrir o OpenAPI.

Tabelas, campos e relações

Esta referência descreve a estrutura publicada, sem registros de credores. O catálogo autenticado GET /dados é a fonte de verdade do ambiente consultado.

Não foi possível carregar as tabelas. Tentar novamente ou abrir o catálogo JSON.

Erros e limites

Verifique o status HTTP antes de ler os dados. As falhas REST retornam {error: {code, message}, requestId}. Informe o requestId ao investigar um erro; nunca registre a chave ou o cabeçalho Authorization.

O serviço limita a quatro as consultas REST simultâneas. Para SSE, INVALID_CREDENTIAL e SCOPE_REQUIRED encerram o consumo. Corrija consultas com INVALID_QUERY, INVALID_CURSOR, RESOURCE_UNAVAILABLE, AGGREGATION_TOO_LARGE ou SNAPSHOT_TOO_LARGE antes de repetir. STREAM_UNAVAILABLE, STREAM_TIMEOUT e STREAM_LIMIT permitem reconexão controlada.

Exemplos e arquivos

Use o OpenAPI em ferramentas de desenvolvimento e os exemplos no servidor da sua aplicação. Configure as variáveis de ambiente antes da execução.