Introdução Plataforma RendimentoPay

Objetivo

Proporcionar, ao leitor, um entendimento claro do padrão utilizado pela Plataforma RendimentoPay.

Glossário

• REST: sigla para Representational State Transfer, é um padrão de arquitetura que define um conjunto de regras para troca de mensagem entre Serviços Web que utilizam o protocolo HTTP;
• JSON: sigla para Javascript Object Notation, é um formato simples para troca de dados, que define um padrão em texto auto descritivo para a transferência de informações;
• OAuth: protocolo que permite aos usuários ter acesso limitado a recursos de uma api sem precisar expor suas credenciais;
• RSA: criptografia assimétrica, dispondo de chave pública e privada, para transmissão de forma segura dos dados sensíveis;
• Access_token: token gerado que permite a utilização dos recursos da api.

Características da solução

A Plataforma disponibiliza para integração de parceiros e clientes, serviços web desenvolvidos em padrão REST, que possibilita a interoperabilidade entre aplicações, independente da tecnologia utilizada para sua confecção.

As mensagens trocadas no consumo destes serviços serão em formato JSON e as operações definidas de acordo com os métodos HTTP:

Segurança

Visando garantir toda segurança necessária, para habilitar-se ao consumo dos serviços oferecidos pela Plataforma RendimentoPay, é necessário anteriormente autenticar a aplicação cliente utilizando o fluxo baseado no padrão OAuth, descrito no documento "Manual Técnico de autenticação".

Ao enviar dados sensíveis, deve-se criptografá-los em RSA utilizando a chave pública obtida no processo de autenticação.

API para Parceiros

Objetivo

Proporcionar ao leitor um entendimento claro do processo de integração para consumo das API’s Rendimento Pay.

client_id: Informar o client id recebido da RendimentoPay.

access_token: Informar o access_token obtido na autenticação.

Content-Type: application/json

 {
  "conteudo": {
    "lista": [  
	      "data": "2023-09-19T11:48:03",
	      "dataDaPostagem": "2023-09-19T00:00:00",
	      "tipoDaTransacao": "Descarga",
	      "valorNaMoedaDeOrigem": -1587.97,
	      "valorNaMoedaLocal": -1587.97,
	      "valorDeTolerancia": null,
	      "nomeDoEstabelecimento": "Transação do Emissor",
	      "enderecoDoEstabelecimento": "-",
	      "tipoDoEstabelecimento": "-",
	      "categoria": "Outros",
	      "pais": "BRASIL",
	      "codigodeAutorizacao": "1Q6TQF",
	      "numeroDeReferencia": "32589139",
	      "postado": true,
	      "descricao": "Completada Com Sucesso",
	      "valorLiquido": null,
	      "moedaOrigem": "BRL",
	      "simboloMonetarioMoedaOrigem": "R$"
	      "moedaLocal": "BRL"
	      "simboloMonetarioMoedaLocal": "R$" 
	      "descricaoDecline": "Transacao Aprovada"
	      "revertida": false
	      "caducada": false
	      "numeroDoProxy": "9076504501660"
	      "dataDaTransacao": "2023-09-19T11:48:03"
	      "descricaoRevertida": ""
	      "pendente": false
	      "pertenceAdicional": true
	      "numRef": "32589139"
	      "transactionCodeId": 231937 
            ] 
 },
  "erros": [],
  "alertas": [],
  "sucesso": true
}