Getting Started with Tesser API (v1)
Introduction
The Tesser Payments Platform API documentation (v1)
Install the Package
Install the gem from the command line:
gem install tesser-api-sdk -v 1.0.0
Or add the gem to your Gemfile and run bundle:
gem 'tesser-api-sdk', '1.0.0'
For additional gem details, see the RubyGems page for the tesser-api-sdk gem.
IRB Console Usage
You can explore the SDK interactively using IRB in two ways
1. Use IRB with Installed Gem
Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
irb
Now you can load the SDK in the IRB
require 'tesser_apiv1'
include TesserApiv1
2. Use IRB within SDK
Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
cd path/to/tesser_apiv1
Now you can start the preconfigured irb console by running the following command
ruby bin/console
Note: This automatically loads the SDK from lib/
Test the SDK
To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:
rake
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
| connection | Faraday::Connection |
The Faraday connection object passed by the SDK user for making requests |
| adapter | Faraday::Adapter |
The Faraday adapter object passed by the SDK user for performing http requests |
| timeout | Float |
The value to use for connection timeout. Default: 60 |
| max_retries | Integer |
The number of times to retry an endpoint call if it fails. Default: 0 |
| retry_interval | Float |
Pause in seconds between retries. Default: 1 |
| backoff_factor | Float |
The amount to multiply each successive retry's interval amount by in order to provide backoff. Default: 2 |
| retry_statuses | Array |
A list of HTTP statuses to retry. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524] |
| retry_methods | Array |
A list of HTTP methods to retry. Default: %i[get put] |
| http_callback | HttpCallBack |
The Http CallBack allows defining callables for pre and post API calls. |
| proxy_settings | ProxySettings |
Optional proxy configuration to route HTTP requests through a proxy server. |
| bearer_auth_credentials | BearerAuthCredentials |
The credential object for OAuth 2 Bearer token |
The API client can be initialized as follows:
Code-Based Client Initialization
require 'tesser_apiv1'
include TesserApiv1
client = Client.new(
bearer_auth_credentials: BearerAuthCredentials.new(
access_token: 'AccessToken'
)
)
Environment-Based Client Initialization
require 'tesser_apiv1'
include TesserApiv1
# Create client from environment
client = Client.from_env
See the Environment-Based Client Initialization section for details.
Authorization
This API uses the following authentication schemes.