• Introdução
• Padronização
• Segurança
• Recursos
  • Cobranças
  • Assinaturas
• Modelos

A Bepag API foi criada pensando em automatizar e simplificar a maneira de realizar cobranças e gestão de assinaturas de nossos parceiros. Ela pode ser usada em conjunto com sistemas já existentes (como ERPs, plataformas de ecommerces e etc.), apenas requisitando os recursos necessários e transferindo para ela todas as responsabilidades das cobranças.

Trabalhamos com sistemas de cobranças que possibilitam o pagamento em boleto ou por pix e gerenciamento de assinatura para criação de cobranças automáticas.

Nossa documentação busca detalhar e explanar todos os recursos, mas caso alguma dúvida surja, entre em contato conosco.

Nossa API foi projetada utilizando o conceito de serviços REST, charset UTF-8 e formato JSON para troca de mensagens (requisição e resposta).

Tecnologia	Descrição
REST	Modelo arquitetural que consiste de um conjunto coordenado de restrições aplicadas a componentes, conectores e elementos de dados dentro de um sistema distribuído.
UTF-8	Tipo de codificação Unicode de comprimento variável. Pode representar qualquer caracter Unicode, sendo também compatível com o ASCII.
JSON	Formato leve para troca de informações entre aplicações. Embora seja um acrônimo para JavaScript Object Notation, pode ser utilizado independentemente de linguagem de programação.

Para trabalhar em cada recurso, a integração deverá utilizar os quatro principais verbos existentes do protocolo HTTP: GET, POST, PUT e DELETE.

Verbo	Objetivo
GET	Deverá ser utilizado sempre que o objetivo for obter informações sobre determinado recurso. Por exemplo: listar clientes ou listar notas fiscais.
POST	Deverá ser utilizado sempre que o objetivo for salvar uma nova instância de algum recurso. Por exemplo: salvar novo cliente ou emitir nova NFCe.
PUT	Deverá ser utilizado sempre que o objetivo for alterar ou completar informações sobre determinada instância de algum recurso. Por exemplo: alterar preço do produto ou alterar endereço do cliente.
DELETE	Deverá ser utilizado sempre que o objetivo for remover uma instância de algum recurso. Por exemplo: excluir cliente ou excluir produto.

Todas as requisições de serviços devem ser autenticadas pela chave de integração, garantindo a segurança dos dados de cada cliente. A chave de integração é única para cada empresa, sendo adquirida na página "Minha conta", em dados de integração dentro da sua plataforma Bepag.

No cabeçalho da requisição HTTP o parâmetro Authorization deve conter o valor "Bearer {chave de integração da empresa}", já o parâmetro Content-Type deve conter o valor "application/json".

Authorization: Bearer {chave de integração da empresa}
Content-Type: application/json

Após isso, defina a URI da requisição, verbo HTTP para definir a ação a ser executada no recurso, o conteúdo da mensagem (se for o caso) e analise o retorno.

Veja abaixo todos os recursos expostos no momento e como interagir com cada um deles.

Para realizar as requisições de nossa API utilize o link "https://app.myse.com.br:8443/bepag_api/rest" como ponto de requisição.