Connect

Nesta página, você encontrará os passos principais para conectar sua aplicação ao sistema PagBank. E-commerce, marketplaces e sistemas de conciliação são exemplos de aplicações que podem ser conectadas ao PagBank. Ao fazer essa integração, sua aplicação será capaz de executar ações em nome dos usuários do PagBank. Para isso, é necessário registrar sua aplicação no PagBank e estabelecer a conexão com as contas dos usuários, caso eles já tenham uma conta aberta.

📘

Definição de usuário

Quando mencionamos usuário ao longo da documentação da API Connect, nos referimos ao vendedor. Ou seja, ao dono ou responsável pela aplicação criada.

O usuário/vendedor terá sua conta vinculada à aplicação e essa aplicação realizará ações em seu nome.

Utilizando a API Connect

O primeiro passo é criar uma aplicação no sistema PagBank, que corresponde ao seu E-commerce, por exemplo. Durante esse processo, você fornecerá informações necessárias para identificar o seu negócio, como nome, descrição e logotipo, além de definir o URL de redirecionamento após a aprovação das permissões pelo usuário. Para criar a sua aplicação, utilize o endpoint Criar aplicação. Na resposta são fornecidos parâmetros de identificação da sua aplicação, client_id e account_id.

Caso você queira recuperar os dados da sua aplicação, você pode utilizar o endpoint Consultar aplicação.

Receba autorização do usuário

Após criar uma aplicação no PagBank e integrá-la ao seu sistema, como segundo passo você precisa da autorização do vendedor para realizar ações em seu nome. Nesta etapa, você pode solicitar a autorização e obter um código de confirmação de duas maneiras diferentes, utilizando o Connect Authorization ou o Connect via SMS:

• Connect Authorization: Este método permite que você solicite a autorização dos vendedores por meio de um processo de autenticação padrão, redirecionando o usuário para uma página PagBank.
• Connect via SMS (Autorização via SMS): Com esse método, você pode solicitar a autorização dos vendedores através do envio de um código de autenticação via SMS. Para utilizar o Connect SMS, utilize o endpoint Solicitar permissão via SMS. A permissão concedida usando o Connect SMS permite apenas criar transações e realizar consultas. No entanto, não é possível realizar estornos nem acessar dados cadastrais do vendedor por meio dessa forma de autorização.

📘

Connect Authorization ou Connect via SMS

Ambas as soluções permitem que você receba a autorização para efetuar ações em nome do usuário.

Com o Connect Autorization, essa autorização será concedida através de uma página do PagBank.

Utilizando o Connect via SMS, a autorização pode ser realizada inteiramente no seu sistema, utilizando endpoints para requisitar os dados ao usuário e transferir os códigos de acesso.

Ao final do processo de autorização, independente de qual foi utilizado, você terá em mãos o código de confirmação do vendedor (access token).

Obtenha o token de acesso

No terceiro e último passo do processo de conexão, você utilizará o código de confirmação para obter o token de acesso (access_token). O access_token será utilizado em requisições futuras e confirmará a sua autenticidade ao realizar operações em nome desse vendedor. Portanto, você deve armazenar o access_tokenem seu sistema e vinculá-lo ao vendedor correspondente. Para obter o access_token você utilizará o endpoint Obter access token. Siga para a seção Access token para mais informações.

A imagem a seguir sumariza o fluxo principal da API Connect:

Operações complementares

Além dos três passos descritos, a API Connect fornece endpoints adicionais para contemplar serviços complementares:

• Renovar access token: utilizado para renovar a validade do access_token.
• Revogar access token: revoga o acesso à conta de um vendedor.

Por fim, a API Connect também incorpora o processo de utilização de autenticação de dois fatores. Acesse a página Connect challenge para entender como utilizar essa solução.

Access token

A partir do código de confirmação (code ou sms_code) obtido anteriormente, você irá obter o access_token. Assim, você será capaz de realizar requisições em nome do usuário. Para obter o access_token utilize o endpoint Obter access token.

Ao realizar a requisição ao endpoint, você deve definir qual foi a autenticação utilizada sms, authorization_codeou challenge. Como resposta, você receberá o access_token ao qual o usuário foi vinculado e também o refresh_token, utilizado para renovar as suas credenciais periodicamente. A validade do access_token também é informada na resposta.

Para renovar o access_token, você deve utilizar o endpoint Renovar access token. Nele, você irá fornecer o refresh_token e receberá na resposta:

• Um novo access_token que pode ser utilizado até a nova data de expiração.
• Um novo refresh_token que será utilizado na próxima renovação.