Connect Authorization
Os passos relacionados ao processos de autorização usando o Connect Authorization são apresentados nessa página.
1. Redirecione o usuário
Você deve redirecionar o usuário para a página do PagBank. As informações relacionadas às permissões que você irá requisitar para o usuário serão fornecidas como query params na URL de redirecionamento. A tabela a seguir informa todos os possíveis parâmetros que podem ser incorporados na URL.
| Parâmetro | Tipo | Descrição |
|---|---|---|
client_id | String (36 caracteres) | Identificador único fornecido no momento da criação da aplicação. |
response_type | String (ENUM) | Define o tipo de resposta desejado. Por padrão utilize code. |
redirect_uri | String (5 - 350 caracteres) | URL para o redirecionamento do usuário após a autorização. Deve ser a mesma utilizada na criação da aplicação. |
scope | String (150 caracteres) | Permissões de acesso solicitadas. |
code | String (32 caracteres) | Código de autorização. Você trocará ele por um access_token. O código só pode ser usado uma única vez e tem a válidade de 10 min. |
state | Alfanumérico (128 caracteres) | Possibilita o repasse de informações necessárias para sua autorização. O concedente pode utilizar para controlar o acesso. |
O parâmetro scopedefine o nível de permissão atribuído ao vendedor. Os possíveis valores para scope e as permissões relacionadas são apresentados a seguir:
payments.read: Permissão para visualizar pedidos e cobranças.payments.create: Permissão para criar e visualizar pedidos e cobranças.payments.refund: Permissão para fazer reembolsos.accounts.read: Permissão para consultar os dados de cadastro do vendedor.checkout.create: Permissão para criar checkout PagBank.checkout.view: Permissão para visualizar checkout PagBank.checkout.update: Permissão para atualizar checkouts PagBank criados.
Caso deseje adicionar mais de uma permissão, combine seus identificadores usando o símbolo "+": payments.read+payments.create.
A seguir é apresentado um exemplo de URL para o ambiente Sandbox:
https://connect.sandbox.pagbank.com.br/oauth2/authorize?response_type=code&client_id=partner_client_id&redirect_uri=partner_callback_url&scope=scope.name1+scope.name2&state=xyz
Para o ambiente de Produção, a seguinte URL base deve ser utilizada:
https://connect.pagbank.com.br/oauth2/authorize?
Você tem a opção de utilizar a página Solicitar autorização via Connect Authorization para construir essa URL. No entanto, é importante ressaltar que esse não é um endpoint. Você deve utilizar a URL gerada para redirecionar o seu usuário.
2. Login do vendedor
Se o vendedor já possui uma conta no PagBank, ele será solicitado a fazer login para visualizar as permissões que serão concedidas.
No caso do ambiente Sandbox, será necessário utilizar informações do vendedor teste para realizar o login. Para obter as informações do vendedor teste você deve acessar a sua conta Sandbox. Caso ainda não tenha uma conta se registre acessando a página do PagBank Sandbox. Depois, no menu Perfil de Integração, acesse Aplicação e obtenha e-maile senha do vendedor teste. Utilize essas informações para finalizar o passo 2.
3. Aprovação pelo vendedor
Após revisar as permissões, o vendedor pode aprovar ou negar o acesso. Se o vendedor aprovar as permissões, ele será redirecionado para a redirect_uri com um código de aprovação (code). A seguir é apresentado um exemplo para a URL para a qual o usuário poderia ser redirecionado:
\<redirect_uri>?code\<code_fornecido_PagBank>&state=\<valor_fornecido_passo_1>
4. Obtenha o access token
Utilize o código code e o endpoint Obter access token para obter o access_token utilizado para autorizar operações futuras relacionadas a esse vendedor. Confira mais informações na seção Access token.
Validade do código
O código
codesó pode ser usado uma única vez e tem a válidade de 10 minutos.
Mudança de e-mail pelo usuário
Se o usuário alterar o e-mail usado para autorizar a aplicação no PagBank, será necessário realizar uma nova autorização usando o novo e-mail.
Updated 2 months ago