Getting Started with sticky.io Restful API v2025.7.31

Introduction

sticky.io Restful API offers some new functionality as well as fully restful routes. All request with a payload should be sent as JSON. The authorization used is Basic Authentication

Version 1 JSON API

Requests

API requests that call for a request body are expected to be in JSON Format.

Responses

The v2 standard JSON responses will usually contain at least the following:

Field Data Type Description
status String Status of the API call. "SUCCESS" or "FAILURE" are possible values.
data Mixed Data returned by API call. It could be an object or an array of objects.

List Responses

GET requests that return a list of entities will usually contain the following:

Field Data Type Description
status String Status of the API call. "SUCCESS" or "FAILURE" are possible values.
data Mixed Data returned by API call. It could be an object or an array of objects.
current_page Integer Current page associated with the dataset returned in data.
first_page_url String URL that maps to the first paginated list of a given entity.
last_page Integer Number of pages in a given dataset.
last_page_url String URL that maps to the last paginated list of a given entity.
next_page_url String URL that maps to the next paginated list of a given entity.
path String URL that maps to the index page of a given entity.
per_page Mixed Data returned by API call. It could be an object or an array of objects.
prev_page_url Mixed Data returned by API call. It could be an object or an array of objects.
from Integer Offset record number lower bound.
to Mixed Offset record number upper bound.
total Integer Total amount of records that exist for a given entity.

Install the Package

Install the gem from the command line:

gem install apimatic-sticky-apis-sdk -v 0.0.1

Or add the gem to your Gemfile and run bundle:

gem 'apimatic-sticky-apis-sdk', '0.0.1'

For additional gem details, see the RubyGems page for the apimatic-sticky-apis-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 'sticky_io_restful_api_v2025731'
include StickyIoRestfulApiV2025731

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

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
environment Environment The API environment.
Default: Environment.PRODUCTION
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.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
basic_credentials BasicCredentials The credential object for Basic Authentication
bearer_credentials BearerCredentials The credential object for OAuth 2 Bearer token

The API client can be initialized as follows:

Code-Based Client Initialization

require 'sticky_io_restful_api_v2025731'
include StickyIoRestfulApiV2025731

client = Client.new(
  basic_credentials: BasicCredentials.new(
    username: 'username',
    password: 'password'
  ),
  bearer_credentials: BearerCredentials.new(
    access_token: 'AccessToken'
  ),
  environment: Environment::PRODUCTION,
  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 'sticky_io_restful_api_v2025731'
include StickyIoRestfulApiV2025731

# Create client from environment
client = Client.from_env

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name Description
PRODUCTION Default

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities