Visão geral

Esta documentação reúne as integrações públicas e privadas do Simplifica em um formato público, navegável e mais amigável para integração.

Ela foi pensada para três perfis principais:

• times técnicos que precisam integrar com segurança;
• usuários mais leigos que precisam entender por onde começar;
• agentes de IA e automações que precisam consultar dados da plataforma com previsibilidade.

O que você encontra aqui

• pessoas, categorias, segmentos, consultores e demais cadastros de CRM;
• atividades, follow-ups e reuniões;
• ações de follow-up para agendar, finalizar e cancelar;
• oportunidades, vendas, produtos e cadastros comerciais;
• receitas, despesas e cadastros do financeiro;
• visões consolidadas, como assinatura por oportunidade.

Como ler esta documentação

• a aba Documentação explica autenticação, paginação, filtros e exemplos práticos;
• a página Lista de APIs privadas mostra as rotas privadas publicadas com método, endpoint e exemplo de resposta;
• a página Cadastros CRM · criar e atualizar mostra as primeiras rotas de escrita para cadastros auxiliares do CRM;
• a página Atividades e follow-ups · criar e agir mostra a primeira prova de conceito de escrita privada operacional;
• a página Reuniões · criar e agir reúne os writes de motivos de reunião, motivos de cancelamento e ações operacionais de reunião;
• a página Consultório · criar e agir reúne os writes já liberados para motivos de consulta, motivos de cancelamento e bloqueios de agenda;
• a página API Lead cobre a integração pública de entrada de leads;
• a aba Referência da API mostra os endpoints, os campos publicados e os tipos retornados;
• em cada endpoint, comece sempre pela chamada mais simples, sem filtros;
• depois use limit, offset e q somente quando precisar refinar a consulta.
• vários recursos retornam referências por ID para preservar performance, então a integração ideal sincroniza também os cadastros auxiliares.

Primeira chamada recomendada

Antes de pensar em filtros, faça uma consulta limpa para entender a estrutura do retorno:

1
GET {{base_url}}/simplificav2/oportunidade
2
Authorization: Bearer {{bearer_token}}
3
Accept: application/json

Essa abordagem evita confusão e ajuda você a enxergar:

• quais campos aquele recurso publica;
• como a paginação funciona;
• quais filtros fazem sentido para aquele endpoint.

O que esperar das respostas

As listagens retornam, em geral:

• items: lista de registros;
• count: quantidade retornada naquela resposta;
• limit: limite aplicado;
• offset: deslocamento aplicado;
• hasMore: indica se ainda existem mais páginas;
• links: links de navegação gerados pelo ORDS.

Próximos passos