Hydrogen Proton API

Hydrogen Proton API

  • API version: 1.9.0
    • Build date: 29-06-2021

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

Documentation

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

Requirements

  1. Ruby 2.7+

Installation

Install via Ruby Gems

Install the gem:

gem install proton_api

The add this to the Gemfile:

gem 'proton_api', '~> 1.9'

Getting Started

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

Base URL

  1. Go to configuration file located under lib folder.
  2. Search for @host and change/verify the URL according to the environment.

Sandbox Base URL sandbox.hydrogenplatform.com

Production Base URL api.hydrogenplatform.com

# Load the gem
require 'proton_api'

# Setup authorization
ProtonApi.configure do |config|
# Use one of the below method to generate oauth token        
# Creating a token for grant_type=client_credentials
 config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
# Creating a token for grant_type=password
 config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
# Creating a token using client token
 config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
end
api_instance = ProtonApi::AnnuitiesApi.new

annuity_calculator_accumulation_horizon_request = ProtonApi::AnnuityCalculatorAccumulationHorizonRequest.new # AnnuityCalculatorAccumulationHorizonRequest | Request payload for Annuity Calculator - Accumulation Horizon
begin
  #Annuity Calculator - Accumulation Horizon
  result = api_instance.annuity_calculator_accumulation_horizon(annuity_calculator_accumulation_horizon_request)
  p result
rescue ProtonApi::ApiError => e
  puts "Exception when calling AnnuitiesApi->annuity_calculator_accumulation_horizon: #{e}"
end

Author

The Hydrogen Technology Corporation

https://www.hydrogenplatform.com

Generated using Swagger Codegen