> For the complete documentation index, see [llms.txt](https://ajuda.financeiro.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.financeiro.app/api/parceiros.md).

# API para Parceiros

A API para Parceiros do [**Falcon Finanças**](https://falcon.financeiro.app) permite administrar os clientes vinculados à integração e suas configurações de plano.

## Recursos disponíveis

| Área         | Operações                                            |
| ------------ | ---------------------------------------------------- |
| Autenticação | Realizar login e obter o token JWT.                  |
| Clientes     | Consultar e filtrar clientes vinculados.             |
| Planos       | Consultar e atualizar limites e recursos do cliente. |
| Vínculos     | Inativar o vínculo de um cliente.                    |

## Contrato OpenAPI

A referência técnica é gerada automaticamente pelo contrato `partners-v1` da Falcon API. Apenas endpoints marcados explicitamente para parceiros fazem parte desse documento.

No GitBook, a especificação `falcon-api-parceiros-v1` utiliza esta fonte pública:

```
https://api.financeiro.app/openapi/partners-v1.json
```

{% hint style="info" %}
Rotas operacionais de Codex, webhooks e outros serviços internos não são incluídas nesta documentação.
{% endhint %}

Consulte os [endpoints disponíveis](/api/parceiros/endpoints-disponiveis.md) para uma visão rápida do contrato atual.