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

# Referência da API

> URLs base, autenticação, cabeçalhos e erros comuns a todas as rotas da API de Parceiros.

A API de Parceiros é a API dos aplicativos parceiros aprovados, como logbooks, que agem em nome de um piloto que concedeu acesso a eles na tela de consentimento do MyPilotIndex. As rotas de parceiro ficam sob `/v1/partner/` e nunca são servidas a navegadores.

## URLs base

| Ambiente | Host |
| - | - |
| Sandbox | Entregue ao parceiro junto com a credencial de sandbox, no ambiente de dev na AWS, com pilotos fictícios. |
| Produção | Anunciado no lançamento. |

## Autenticação

Autentique-se com um access token do endpoint de token do provedor de identidade (`grant_type=client_credentials`, scopes `partner/<scope>`) no cabeçalho `Authorization`. Veja [Autenticação](https://developers.mypilotindex.com/pt-br/authentication.md).

```http theme={null}
Authorization: Bearer <access_token>
```

Para testar uma rota no playground, cole um access token de sandbox no campo de autorização dela.

## Cabeçalhos de limite de uso

Toda resposta autenticada traz `X-RateLimit-Limit` e `X-RateLimit-Remaining`, a cota diária do parceiro e o que resta dela. Um `401`, e um caminho ou método fora desta API, não trazem nenhum dos dois. Passada a cota, a API responde `429 rate_limited` com `Retry-After`. Veja [Limites de uso](https://developers.mypilotindex.com/pt-br/rate-limits.md).

## Erros

Os erros usam um envelope comum com um `code` estável, uma `message` segura, um `correlation_id` e um `reason` opcional. Veja [Erros](https://developers.mypilotindex.com/pt-br/errors.md).

## Versionamento

A API só cresce dentro da v1: campos e rotas novos podem aparecer, e os que existem não mudam de sentido. Veja o [histórico de mudanças](https://developers.mypilotindex.com/pt-br/changelog.md).

## O documento OpenAPI

A referência é gerada a partir do documento OpenAPI 3.1 da API de Parceiros. Baixe-o pelo menu no topo de qualquer página de endpoint para gerar um cliente.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.