Skip to content

Latest commit

 

History

History
106 lines (76 loc) · 3.99 KB

README.md

File metadata and controls

106 lines (76 loc) · 3.99 KB

Java Script SDK Client - Plataforma de Ressarcimento do Open Banking Brasil

PlataformaDeRessarcimentoDoOpenBankingBrasil - JavaScript client for plataforma_de_ressarcimento_do_open_banking_brasil APIs da plataforma de Ressarcimento do Open Banking Brasil para a comunicação online com a plaforma. Através da documentação das APIs abaixo é possível realizar os devidos testes de integração. This SDK is automatically generated by the Swagger Codegen project:

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install plataforma_de_ressarcimento_do_open_banking_brasil --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var PlataformaDeRessarcimentoDoOpenBankingBrasil = require('plataforma_de_ressarcimento_do_open_banking_brasil');

var api = new PlataformaDeRessarcimentoDoOpenBankingBrasil.RefundAPIV1Api()
var processId = "processId_example"; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findNotificationById(processId, callback);

Documentation for API Endpoints

All URIs are relative to https://ressarcimento.opbkdev.smartfylabs.com

Class Method HTTP request Description
PlataformaDeRessarcimentoDoOpenBankingBrasil.RefundAPIV1Api findNotificationById GET /apis/v1/refund/notifications/{processId} Operação de consulta de processos de transações
PlataformaDeRessarcimentoDoOpenBankingBrasil.RefundAPIV1Api healthcheck GET /apis/v1/refund/notifications/healthcheck Operação de consulta de monitoramento de processos de transações
PlataformaDeRessarcimentoDoOpenBankingBrasil.RefundAPIV1Api notification POST /apis/v1/refund/notifications/ Operação de registro unitário de transação
PlataformaDeRessarcimentoDoOpenBankingBrasil.RefundAPIV1Api notifications PATCH /apis/v1/refund/notifications/ Operação de registro em massa de uma transação

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.