sirako-sdk

SirakoSdk - JavaScript client for sirako-sdk Public endpoints for third-party merchant integrations. Authenticate every request with the X-API-Key header.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.24.0-SNAPSHOT
• 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 sirako-sdk --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 sirako-sdk 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/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 SirakoSdk = require('sirako-sdk');

var defaultClient = SirakoSdk.ApiClient.instance;
// Configure API key authorization: apiKeyAuth
var apiKeyAuth = defaultClient.authentications['apiKeyAuth'];
apiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token"

var api = new SirakoSdk.MerchantPayInApi()
var xAPIKey = "xAPIKey_example"; // {String} 
var paymentId = "paymentId_example"; // {String} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPayment(xAPIKey, paymentId, callback);

Documentation for API Endpoints

All URIs are relative to https://dev-sirako.fidelity-market.com

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- SirakoSdk.MerchantPayInApi | getPayment | GET /api/v1/payments/{paymentId} | Read a merchant pay-in SirakoSdk.MerchantPayInApi | getPaymentOptions | GET /api/v1/payments/options | Get available payment operators for a country SirakoSdk.MerchantPayInApi | initiate | POST /api/v1/payments/initiate | Initiate a merchant pay-in SirakoSdk.MerchantPayInApi | submitOtp | POST /api/v1/payments/{paymentId}/actions/otp | Submit a required OTP action

Documentation for Models

• SirakoSdk.Customer
• SirakoSdk.MerchantPaymentRequest
• SirakoSdk.MerchantPaymentResponse
• SirakoSdk.NextAction
• SirakoSdk.OtpActionRequest

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

apiKeyAuth

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header