Primeiros passos

Bem-vindo ao guia de integração das APIs do Pinbank. Este manual irá orientá-lo em todo o processo de configuração do seu ambiente e na realização da sua primeira chamada de API bem-sucedida.

Objetivos

O objetivo deste guia é fazer com que você consiga realizar uma chamada de API autenticada em nosso ambiente de testes.

Ambientes

Oferecemos dois ambientes distintos para a utilização de nossas APIs. É fundamental entender a finalidade de cada um:

Desenvolvimento: Um ambiente de testes completo, isolado do ambiente de produção. Utilize-o para desenvolver e testar sua integração com segurança, sem afetar dados reais. Todas as chamadas nesta documentação apontam para este ambiente por padrão.

Produção: O ambiente real, onde as transações financeiras ocorrem. Utilize-o apenas quando sua aplicação estiver homologada e pronta para ser lançada.

As URLs base para cada ambiente são:

Ambiente	URL Base
Desenvolvimento	https://dev.pinbank.com.br/services/api
Produção	https://pinbank.com.br/services/api

Fluxo de integração em 4 passos

O processo completo para consumir nossas APIs é dividido em 4 etapas principais. Siga as páginas nesta seção para ver o detalhe de cada passo.

Obter sua credencial

Solicitar suas credenciais únicas (UserName e KeyValue) para identificar sua aplicação.

Veja o passo a passo detalhado sobre como obter sua credencial

Gerar seu token OAuth2

Usar suas credenciais para gerar um access_token de autenticação.

Gerenciamento do ciclo de vida do token

O access_token possui um tempo de validade definido em expires_in. Diferente de outros fluxos, não há um refresh_token.

Quando o token expirar ou você receber uma mensagem de token inválido, basta realizar este mesmo processo do Passo 2 novamente para gerar um novo access_token. Por questões de segurança, o tempo de expiração pode mudar sem aviso prévio.

Veja o passo a passo detalhado sobre o gerenciamento do ciclo de vida do token

Autorizar suas requisições

Utilizar o access_token para autorizar todas as chamadas que sua aplicação fizer à nossa API.

Veja o passo a passo detalhado sobre como autorizar suas requisições

Consumir as APIs

Com tudo configurado, você estará pronto para explorar o poder das nossas APIs Open Banking.

Segurança: Criptografia das requisições e respostas

Para garantir a máxima segurança e confidencialidade dos dados, todas as chamadas realizadas para a nossa API devem ter seu corpo (payload) criptografado. Da mesma forma, as respostas (responses) que você receberá também estarão criptografadas.

Veja o passo a passo detalhado sobre como consumir nossas API's

Objetivos#

Ambientes#

Fluxo de integração em 4 passos#

Gerenciamento do ciclo de vida do token#

Segurança: Criptografia das requisições e respostas#

Objetivos

Ambientes

Fluxo de integração em 4 passos

Gerenciamento do ciclo de vida do token

Segurança: Criptografia das requisições e respostas