Inicio rápido

De la solicitud de acceso a tu primera llamada a la API de Socios.

La API de Socios de MyPilotIndex está en preparación y todavía no está en el aire. El acceso es por solicitud: usa el formulario de solicitud de acceso y te responderemos con una credencial de sandbox. Nada de esto está disponible en producción hasta que te lo avisemos.

La API de Socios permite que una aplicación aprobada, como un logbook electrónico, trabaje con un piloto que eligió conectarla. El piloto decide, en una pantalla de consentimiento de MyPilotIndex, qué partes de sus datos puede usar el socio.

​

Pasos

1. Solicita acceso

   Completa el formulario de solicitud de acceso con tu empresa, tu sitio web, una dirección de contacto y lo que quieres construir. La solicitud queda guardada para nuestros operadores. No pasa nada más de forma automática, así que respondemos por correo.

2. Recibe tu credencial

   Recibes un client id y un client secret, el host de la API de sandbox, el host del endpoint de token del proveedor de identidad y un secreto de firma de webhooks. Cada secreto se muestra una sola vez.

3. Usa el sandbox

   Los socios aprobados trabajan primero en el entorno dev de AWS. Solo contiene pilotos ficticios, nunca miembros reales. Consulta la guía del sandbox.

4. Obtén un token

   Llama al endpoint de token con el flujo client credentials de OAuth 2.0 (grant_type=client_credentials), autenticación de cliente HTTP Basic y los scopes que necesitas escritos como partner/<scope>, por ejemplo partner/hours.write. Consulta la guía de autenticación.

5. Envía al piloto a la pantalla de consentimiento

   Redirige el navegador del piloto a https://mypilotindex.com/connect/{slug} con client_id, redirect_uri, scope, state, code_challenge y code_challenge_method=S256. Consulta la guía de consentimiento.

6. Intercambia el código

   El piloto inicia sesión y te autoriza, y su navegador vuelve a tu redirect_uri con un code y tu state. Llama a POST /v1/partner/grants/exchange con el código, tu code_verifier de PKCE y el redirect_uri. La respuesta contiene el id del grant, el id pairwise del piloto y los scopes que concedió.

7. Llama a la API

   Cada llamada posterior indica el grant: lee el resumen con GET /v1/partner/grants/{grant_id}/summary, o envía los totales del logbook con PUT /v1/partner/grants/{grant_id}/flight-totals.

8. Escucha los webhooks

   Cuando un piloto te desconecta, MyPilotIndex envía grant.revoked. Borra lo que guardas de ese piloto. Consulta la guía de webhooks.

​

Una primera llamada

Get a token

curl -X POST https://{token-host}/oauth2/token \
  -u "$CLIENT_ID:$CLIENT_SECRET" \
  -d "grant_type=client_credentials" \
  --data-urlencode "scope=partner/profile partner/score"

Luego envía el token como Bearer token:

Read a pilot summary

curl https://{api-host}/v1/partner/grants/{grant_id}/summary \
  -H "Authorization: Bearer $ACCESS_TOKEN"

La referencia de la API lista cada operación, sus parámetros, sus respuestas y ejemplos.