javascript

Hydrogen Proton API

Hydrogen Proton API

• API version: 1.9.2
  • Build date: 01-07-2021

For more information, please visit https://www.hydrogenplatform.com/apis

Documentation

https://www.hydrogenplatform.com/docs/proton/v1

Requirements

Building the API client library requires:

1. Node.js

Installation

Install via NPM

npm i @hydrogenplatform/[email protected] --save

Install Locally

To use the library locally without pulling from the 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

Finally, switch to the directory you want to use your hydrogen_nucleus_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('@hydrogenplatform/hydrogen-proton-api') in javascript files from the directory you ran the last command above from.

Getting Started

Please first follow the installation instructions. Then make sure you use the proper base URL:

Base URL

Create an object of AuthApi and update the environment using setEnvironment method.

Sandbox Base URL

var api = new HydrogenProtonApi.AuthApi();

api.setEnvironment(defaultClient.SANDBOX);

Production Base URL

var api = new HydrogenProtonApi.AuthApi();

api.setEnvironment(defaultClient.PRODUCTION);

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

var HydrogenProtonApi = require('@hydrogenplatform/hydrogen-proton-api');

var defaultClient = HydrogenProtonApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];

// Create an instance of the Auth API class
var api = new HydrogenProtonApi.AuthApi();
api.setEnvironment(defaultClient.SANDBOX);
// Callback function definition
var tokenGenerationCallback = function (error, data, response) {
    if (error) {
        console.error(error);
        process.exit(1);
    } else {
        console.log(response.request.method + ' : ' + response.request.url + '\n' + 'Output: ' + JSON.stringify(data, null, '\t') + '\n');
        oauth2.accessToken = data.access_token;
        annuityCalculatorAccumulationHorizonRequest();
    }
};
//          Use one of the below method to generate oauth token
// Token Generation for grant_type = client_credentials
api.createUsingPostClientCredentials({
    'grant_type': 'client_credentials',
    'client_id': 'MYCLIENTID',
    'client_secret': 'MYCLIENTSECRET'
}, tokenGenerationCallback);

// Token Generation for grant_type = password
api.createUsingPostPassword({
    'grant_type': 'password',
    'username' : 'MYUSERNAME',
    'password' : 'MYPASSWORD',
    'client_id': 'MYCLIENTID',
    'client_secret': 'MYCLIENTSECRET'
}, tokenGenerationCallback);

//Token Generation using client token
api.createUsingPostClientTokenCredentials({
    'client_id': 'MYCLIENTID',
    'client_secret': 'MYCLIENTSECRET',
    'Client-Token' : 'Client-Token'
}, tokenGenerationCallback);


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
const annuityCalculatorAccumulationHorizonRequest = () => {
    var api = new HydrogenProtonApi.AnnuitiesApi()
    var annuityCalculatorAccumulationHorizonRequest = new HydrogenProtonApi.AnnuityCalculatorAccumulationHorizonRequest(); // {AnnuityCalculatorAccumulationHorizonRequest} Request payload for Annuity Calculator - Accumulation Horizon
    api.annuityCalculatorAccumulationHorizon(annuityCalculatorAccumulationHorizonRequest, callback);
}

Author

The Hydrogen Technology Corporation

https://www.hydrogenplatform.com

Generated using Swagger Codegen