Referencia de la API

URLs base, autenticación, encabezados y errores comunes a todas las rutas de la API de Socios.

La API de Socios es la API de las aplicaciones de socios aprobadas, como los logbooks, que actúan en nombre de un piloto que les concedió acceso en la pantalla de consentimiento de MyPilotIndex. Las rutas de socio están bajo /v1/partner/ y nunca se sirven a navegadores.

​

URLs base

Entorno	Host
Sandbox	Se entrega al socio con su credencial de sandbox, en el entorno dev de AWS, con pilotos ficticios.
Producción	Se anuncia en el lanzamiento.

​

Autenticación

Autentícate con un token de acceso del endpoint de token del proveedor de identidad (grant_type=client_credentials, scopes partner/<scope>) en el encabezado Authorization. Consulta Autenticación.

Authorization: Bearer <access_token>

Para probar una ruta en el playground, pega un token de acceso de sandbox en su campo de autorización.

​

Encabezados de límite de uso

Cada respuesta autenticada incluye X-RateLimit-Limit y X-RateLimit-Remaining, la cuota diaria del socio y lo que queda de ella. Un 401, y una ruta o un método fuera de esta API, no incluyen ninguno de los dos. Pasada la cuota, la API responde 429 rate_limited con Retry-After. Consulta Límites de uso.

​

Errores

Los errores usan un formato común con un code estable, un message seguro, un correlation_id y un reason opcional. Consulta Errores.

​

Versionado

La API solo crece dentro de la v1: pueden aparecer campos y rutas nuevos, y los que existen no cambian de sentido. Consulta el registro de cambios.

​

El documento OpenAPI

La referencia se genera a partir del documento OpenAPI 3.1 de la API de Socios. Descárgalo desde el menú de la parte superior de cualquier página de endpoint para generar un cliente.