Início rápido

Da solicitação de acesso à sua primeira chamada à API de Parceiros.

A API de Parceiros do MyPilotIndex está em preparação e ainda não está no ar. O acesso é por solicitação: use o formulário de solicitação de acesso e responderemos com uma credencial de sandbox. Nada aqui fica disponível em produção até avisarmos você.

A API de Parceiros permite que um aplicativo aprovado, como um logbook eletrônico, trabalhe com um piloto que escolheu conectá-lo. O piloto decide, em uma tela de consentimento do MyPilotIndex, quais partes dos seus dados o parceiro pode usar.

​

Passos

1. Solicite acesso

   Preencha o formulário de solicitação de acesso com a sua empresa, o seu site, um endereço de contato e o que você quer construir. A solicitação fica guardada para os nossos operadores. Nada mais acontece automaticamente, então respondemos por e-mail.

2. Receba a sua credencial

   Você recebe um client id e um client secret, o host da API de sandbox, o host do endpoint de token do provedor de identidade e um secret de assinatura de webhook. Cada secret é mostrado uma única vez.

3. Use o sandbox

   Parceiros aprovados trabalham primeiro no ambiente de dev na AWS. Ele tem apenas pilotos fictícios, nunca membros reais. Veja o guia do sandbox.

4. Obtenha um token

   Chame o endpoint de token com o grant type client credentials do OAuth 2.0 (grant_type=client_credentials), autenticação HTTP Basic do cliente e os scopes de que você precisa escritos como partner/<scope>, por exemplo partner/hours.write. Veja o guia de autenticação.

5. Envie o piloto para a tela de consentimento

   Redirecione o navegador do piloto para https://mypilotindex.com/connect/{slug} com client_id, redirect_uri, scope, state, code_challenge e code_challenge_method=S256. Veja o guia de consentimento.

6. Troque o código

   O piloto entra na conta e permite, e o navegador dele volta para o seu redirect_uri com um code e o seu state. Chame POST /v1/partner/grants/exchange com o código, o seu code_verifier do PKCE e o redirect_uri. A resposta traz o id do grant, o id por parceiro (pairwise id) do piloto e os scopes que ele concedeu.

7. Chame a API

   Toda chamada seguinte indica o grant: leia o resumo com GET /v1/partner/grants/{grant_id}/summary ou envie os totais do logbook com PUT /v1/partner/grants/{grant_id}/flight-totals.

8. Receba os webhooks

   Quando um piloto desconecta você, o MyPilotIndex envia grant.revoked. Apague o que você guarda sobre esse piloto. Veja o guia de webhooks.

​

Uma primeira chamada

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"

Depois envie o token como um Bearer token:

Read a pilot summary

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

A referência da API lista cada operação, seus parâmetros, suas respostas e exemplos.