@pagofacil/api_pago_facil

v2.1.4

Published

3 years ago

API_de_Pago_Fcil

Downloads

0High
0Medium
0Low

ctala

pagofacil api sdk

Javascript SDK for Pago Fácil API

ApiPagoFacil - JavaScript client for api_pago_facil API de Pago Fácil This SDK is automatically generated by the OpenAPI Generator project:

API version: 2.1.4
Package version: 2.1.4
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

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 @pagofacil/api_pago_facil --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your api_pago_facil from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/PSTPAGOFACIL/sdk-apis-javascript then install it via:

    npm install PSTPAGOFACIL/sdk-apis-javascript --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:

//DOTENV es una librería que nos ayudar a cargar variables de entorno desde un archivo .env
require('dotenv').config();
const ApiPagoFacil = require('@pagofacil/api_pago_facil');
//Obtenemos el usuario y la clave desde el archivo .env
const username = process.env.PF_USERNAME;
const password = process.env.PF_PASSWORD;

const loginBody = new ApiPagoFacil.LoginBody(username, password);

const api = new ApiPagoFacil.AuthApi()
var opts = {
    'loginBody': loginBody
};
var callback = function (error, data, response) {
    if (error) {
        console.error(error);
    } else {
        console.log('API called successfully. Returned data: ');
        const loginResponse = data;
        const dataLoginResponse = loginResponse.data;
        const access_token_jwt = dataLoginResponse.access_token_jwt;

        console.log("LOGIN RESPONSE", loginResponse.message, dataLoginResponse, access_token_jwt);
    }
};
api.usersLoginPost(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://apis.pgf.cl

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ApiPagoFacil.AuthApi | usersLoginPost | POST /users/login | Autentificación con usuario y clave. ApiPagoFacil.IndicatorsApi | indicatorsRemittancesGet | GET /indicators/remittances | Obtiene los datos de los abonos (remittances) realizados en una fecha específica y los futuros, además del saldo disponible ApiPagoFacil.PaymentsApi | paymentsGet | GET /payments | ApiPagoFacil.RemittancesApi | remittancesConciliationGet | GET /remittances/conciliation | ApiPagoFacil.TrxsApi | trxsIdGet | GET /trxs/{id} | Obtiene la informacion de la transacción exitosa, asociada a un id ApiPagoFacil.TrxsApi | trxsIdTrxNullificationGet | GET /trxs/{idTrx}/nullification/ | ApiPagoFacil.TrxsApi | trxsIdTrxNullificationPost | POST /trxs/{idTrx}/nullification | ApiPagoFacil.TrxsApi | trxsIdTrxNullificationStatusGet | GET /trxs/{idTrx}/nullification/status | ApiPagoFacil.TrxsApi | trxsPost | POST /trxs | ApiPagoFacil.UsersApi | usersGet | GET /users | Obtener informacion del usuario. ApiPagoFacil.WebhooksApi | webhooksIdUserGet | GET /webhooks/{idUser} | ApiPagoFacil.WebhooksApi | webhooksIdUserWebhookDelete | DELETE /webhooks/{idUser}/{webhook} | ApiPagoFacil.WebhooksApi | webhooksIdUserWebhookPut | PUT /webhooks/{idUser}/{webhook} | ApiPagoFacil.WebhooksApi | webhooksPost | POST /webhooks |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Javascript SDK for Pago Fácil API

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

JWTToken

Token