***

title: Visão geral
subtitle: Documentação das integrações públicas e privadas do Simplifica
slug: welcome
-------------

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;
* 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 `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.
* nesta V1, o padrão operacional documentado de paginação é `100` registros por página;
* 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:

```http
GET {{base_url}}/simplificav2/oportunidade
Authorization: Bearer {{bearer_token}}
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

<CardGroup cols={2}>
  <Card title="Primeira chamada" icon="duotone play" href="/getting-started">
    Veja como autenticar, consultar um endpoint limpo e entender a resposta.
  </Card>

  <Card title="Lista de APIs privadas" icon="duotone lock" href="/private-integrations">
    Veja as rotas privadas com método, endpoint e exemplo de JSON de resposta.
  </Card>

  <Card title="Filtros e paginação" icon="duotone filter" href="/filters-and-pagination">
    Aprenda quando usar `limit`, `offset` e `q`.
  </Card>

  <Card title="Modelo de integração" icon="duotone database" href="/integration-model-and-performance">
    Entenda por que a API devolve referências por ID e como sincronizar os cadastros auxiliares.
  </Card>

  <Card title="Exemplos práticos" icon="duotone lightbulb" href="/use-cases">
    Copie cenários comuns de consulta por pessoa, período, status e relacionamento.
  </Card>

  <Card title="Referência da API" icon="duotone code" href="/api-reference">
    Navegue pelos endpoints e pelos schemas publicados.
  </Card>
</CardGroup>