Getting Started with Reporting: Authorization Summary API

Introduction

Retrieves authorized summaries and supports group by operations.

Install the Package

Install the gem from the command line:

gem install worldpay-apimatic-sdk -v 0.0.1

Or add the gem to your Gemfile and run bundle:

gem 'worldpay-apimatic-sdk', '0.0.1'

For additional gem details, see the RubyGems page for the worldpay-apimatic-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 'reporting_authorization_summary_api'
include ReportingAuthorizationSummaryApi

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/reporting_authorization_summary_api

Now you can start the preconfigured irb console by running the following command

ruby bin/console

Note: This automatically loads the SDK from lib/

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: 30
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.
logging_configuration	`LoggingConfiguration`	The SDK logging configuration for API calls
custom_header_authentication_credentials	`CustomHeaderAuthenticationCredentials`	The credential object for Custom Header Signature

The API client can be initialized as follows:

Code-Based Client Initialization

require 'reporting_authorization_summary_api'
include ReportingAuthorizationSummaryApi

client = Client.new(
  custom_header_authentication_credentials: CustomHeaderAuthenticationCredentials.new(
    authorization: 'Authorization'
  ),
  logging_configuration: LoggingConfiguration.new(
    log_level: Logger::INFO,
    request_logging_config: RequestLoggingConfiguration.new(
      log_body: true
    ),
    response_logging_config: ResponseLoggingConfiguration.new(
      log_headers: true
    )
  )
)

Environment-Based Client Initialization

require 'reporting_authorization_summary_api'
include ReportingAuthorizationSummaryApi

# 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.

api_key (Custom Header Signature)

List of APIs

Authorizations