packageruby

Getting Started with Form3 Public API

Install the Package

Install the gem from the command line:

gem install packageruby -v 1.1.1

Or add the gem to your Gemfile and run bundle:

gem 'packageruby', '1.1.1'

For additional gem details, see the RubyGems page for the packageruby gem.

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.
basic_credentials	BasicCredentials	The credential object for Basic Authentication
o_auth_2_credentials	OAuth2Credentials	The credential object for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

client = Form3PublicApi::Client.new(
  basic_credentials: BasicCredentials.new(
    username: 'Username',
    password: 'Password'
  ),
  o_auth2_credentials: OAuth2Credentials.new(
    o_auth_client_id: 'OAuthClientId',
    o_auth_client_secret: 'OAuthClientSecret'
  )
)

Authorization

This API uses the following authentication schemes.

• Basic (Basic Authentication)
• OAuth2 (OAuth 2 Client Credentials Grant)

List of APIs

• Scheme File API
• Transaction File API
• Metrics API
• Name Verification API
• O Auth Authorization
• Audit
• Reports
• Scheme Messages
• Subscriptions
• Oauth 2
• Accounts
• Account Identification
• Branches
• Branch Identification
• Payments
• Organisations
• Platformsecurityapi
• Roles
• ACE
• Users
• Claims
• Direct Debits
• Mandates
• Query Api
• Account Validation

Classes Documentation

• Utility Classes
• HttpResponse
• HttpRequest