> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flunora.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução

> URL base, autenticação, formatos e convenções comuns a todas as rotas.

A referência descreve cada rota com parâmetros, respostas e um playground para testar com
a sua chave. Esta página cobre o que vale para todas elas.

## URL base

O endereço da **sua instância**, não um domínio compartilhado da plataforma.

```
https://crm.suaempresa.com
```

O playground desta referência tem um campo para trocar esse endereço pelo seu. Detalhes em
[a sua instância](/pages/guias/instancia).

## Autenticação

As rotas de consulta usam chave de API no cabeçalho; a entrada de contatos usa token no
caminho da URL. A diferença e o motivo dela estão em
[autenticação](/pages/guias/autenticacao).

## Formatos

<ResponseField name="Resposta" type="JSON">
  Sempre JSON, em UTF-8. Acentos e cedilha são esperados e não precisam de escape.
</ResponseField>

<ResponseField name="Corpo da requisição" type="JSON nas consultas">
  As rotas de consulta aceitam apenas JSON. A entrada de contatos aceita também formulário
  codificado e multipart.
</ResponseField>

<ResponseField name="Origem" type="CORS só na entrada">
  A entrada de contatos aceita requisição de qualquer origem, o que permite chamá-la do
  navegador. As rotas de consulta não respondem a preflight, de propósito.
</ResponseField>

## Cabeçalhos de limite

As rotas de consulta devolvem o estado do teto da chave quando ele existe.

| Cabeçalho               | Quando aparece      | O que diz                                |
| ----------------------- | ------------------- | ---------------------------------------- |
| `X-RateLimit-Limit`     | Sempre que há teto  | O limite da janela em vigor              |
| `X-RateLimit-Remaining` | Sempre que há teto  | Quanto sobra dela                        |
| `Retry-After`           | Nas respostas `429` | Segundos até valer a pena tentar de novo |

## Sem SDK

Não há biblioteca cliente, e não faz falta: a superfície é uma requisição HTTP com um
corpo simples. Os exemplos cobrem `curl`, JavaScript, PHP e Python, e o playground gera o
código na linguagem que você escolher.

## Estabilidade

O que está nesta referência tem compromisso de estabilidade. O resto da plataforma
responde a rotas autenticadas por sessão, feitas para o produto e não para integração de
terceiros: elas podem mudar sem aviso, então não construa em cima delas.