Bem-vindo ao guia do desenvolvedor das APIs do PagBank. Neste guia, você encontrará todas as informações necessárias para integrar e utilizar as funcionalidades oferecidas pelas nossas APIs. Estas foram implementadas seguindo o padrão RESTful. Utilizamos protocolos HTTP padrão, onde as respostas às solicitações HTTP são retornadas em formato JSON. Todas as operações podem ser realizadas por meio de requisições GET, POST e PUT.
As APIs do PagBank fornecem uma série de serviços. Todas as funcionalidades e guias existentes são apresentados na página de Funcionalidades disponíveis. Utilize essa página para ter uma visão macro do que você encontra nesta documentação e dos serviços as APIs do PagBank disponibilizam para você.
Após se familiarizar com as funcionalidades, consulte a seção de Primeiros passos para compreender o processo de integração e começar a utilizar as APIs disponibilizadas. Nesta página são apresentados os ambientes disponíveis, o processo de criação e homologação de uma conta e o guia para obtenção do token de autenticação. Além disso, são apresentadas informações referentes a chaves públicas e chaves de idempotência.
Ainda na seção de visão geral, você encontrará a lista de Códigos de status. Como as APIs do PagBank seguem o padrão RESTful, códigos de resposta HTTP padrão são utilizados para indicar o sucesso ou problemas durante uma requisição à API.
Integração direta e de plataforma
O sistema do PagBank atende a dois tipos de usuários, clientes diretos e clientes de plataforma.
Os clientes diretos realizam suas vendas utilizando exclusivamente a API de Pedidos do PagBank. Isso ocorre porque eles serão os únicos recebedores no ambiente de desenvolvimento. Ou seja, os clientes diretos irão utilizar primordialmente a API de Pedidos do PagBank.
Por outro lado, os clientes de plataformas e marketplaces devem obrigatoriamente ser integrados à API Connect. Isso é necessário pois eles realizam ações em nome dos usuários. Assim, o uso da API Connect é necessário para que plataformas e marketplaces recebam autorização de seus usuários para receber informações dos vendedores e executar ações em nome deles. Devido a esse requisito adicional, o fluxo de utilização dos clientes de plataforma é um pouco mais complexo, uma vez que necessitam de tais autorizações extras para concluir ações com as APIs do PagBank.