Manual de Integração

1. Introdução

Bem-vindo ao manual de integração da PilotIn Dashboard Insights API - External Partners. Esta API foi desenvolvida para permitir que parceiros externos consultem dados relevantes, como informações bancárias e transações de clientes. Ao facilitar a integração e o acesso a insights importantes, nossa API visa impulsionar a colaboração e a criação de soluções inovadoras.

Este manual o guiará através do processo de autenticação e fornecerá o link para a documentação completa da API, onde você encontrará detalhes sobre os endpoints disponíveis e os modelos de dados.

2. Dados de Acesso

As credenciais de acesso às APIs serão enviadas pelo e-mail autenticado do nosso portal, que faz parte do processo seguro de autenticação. Para seguirmos com o envio, pedimos que nos informe o e-mail corporativo do responsável técnico ou de segurança que ficará encarregado de receber e armazenar as chaves.

As credenciais serão enviadas para esse e-mail, contendo o client_id e o client_secret utilizados para autenticação, além da APIKey, que deve ser incluída no cabeçalho (header) de todas as requisições enviadas à API.

As credenciais terão validade de 1 (um) ano, e um novo e-mail será enviado automaticamente para atualização e renovação segura antes do vencimento.

Após o recebimento, o responsável indicado deverá armazenar as credenciais em um ambiente seguro, como um cofre corporativo (ex.: Azure Key Vault, 1Password Business ou equivalente).

Por motivos de segurança, a PilotIn não mantém cópias das chaves e não se responsabiliza por vazamentos ou uso indevido decorrentes de armazenamento inadequado fora dos canais oficiais.

Por motivos de segurança, também solicitaremos o endereço IP do servidor que irá originar as chamadas às APIs, para que possamos cadastrar o IP na nossa lista de permissões (whitelist) e garantir que apenas conexões autorizadas tenham acesso.

3. Autenticação

Para acessar os recursos desta API, é necessário realizar a autenticação. Abaixo, demonstramos como obter o token de acesso utilizando suas credenciais client_id e client_secret.

Obtenção do Token de Acesso

O token tem uma validade de 1 hora.

Utilize a seguinte requisição curl para obter o seu token:

 curl --location 'https://login.pilotin.com.br/partner/auth' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'X-API-Key: {{API_KEY}}' \ --data-urlencode 'grant_type=client_credentials' \ --data-urlencode 'client_id=<client_id>' \ --data-urlencode 'client_secret=<client_secret>' \ --data-urlencode 'scope=https://pilotinauthentication.onmicrosoft.com/dashboardinsights/forexternalpartners/.default' 

Substitua <client_id> pelo seu ID de cliente e <client_secret> pela sua chave secreta.

O token de acesso será retornado na resposta desta requisição e deverá ser utilizado em chamadas subsequentes à API, geralmente no header Authorization com o prefixo Bearer.

Utilização do Token

Para utilizar o token de acesso, inclua-o no header X-API-Key de suas requisições:

Authorization: Bearer TOKEN