Skip to main content

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

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install apimatic-sticky-apis-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/apimatic-sticky-apis-sdk/0.0.1

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
http_client_instance Union[Session, HttpClientProvider] The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 60
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ["GET", "PUT"]
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

import logging

from stickyiorestfulapiv2025731.configuration import Environment
from stickyiorestfulapiv2025731.http.auth.basic import BasicCredentials
from stickyiorestfulapiv2025731.http.auth.bearer import BearerCredentials
from stickyiorestfulapiv2025731.logging.configuration.api_logging_configuration import LoggingConfiguration
from stickyiorestfulapiv2025731.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from stickyiorestfulapiv2025731.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from stickyiorestfulapiv2025731.stickyiorestfulapiv_2025731_client import Stickyiorestfulapiv2025731Client

client = Stickyiorestfulapiv2025731Client(
    basic_credentials=BasicCredentials(
        username='username',
        password='password'
    ),
    bearer_credentials=BearerCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from stickyiorestfulapiv2025731.stickyiorestfulapiv_2025731_client import Stickyiorestfulapiv2025731Client

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = Stickyiorestfulapiv2025731Client.from_environment(dotenv_path='/path/to/.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

Metadata

Release files for apimatic-sticky-apis-sdk 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apimatic-sticky-apis-sdk 0.0.1
File Size Uploaded Provenance Actions
apimatic_sticky_apis_sdk-0.0.1.tar.gz 303.5 kB Without provenance Details for apimatic_sticky_apis_sdk-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for apimatic-sticky-apis-sdk 0.0.1
File Interpreter ABI Platform Actions
apimatic_sticky_apis_sdk-0.0.1-py3-none-any.whl Python 3 none any Details for apimatic_sticky_apis_sdk-0.0.1-py3-none-any.whl

Total release size: 1.5 MB

Release files / apimatic_sticky_apis_sdk-0.0.1.tar.gz

Download URL apimatic_sticky_apis_sdk-0.0.1.tar.gz
Size 303.5 kB
Tags Source
SHA-256 checksum
How to use checksums
596b8b45702283ecedcb684bac1ea06c35a60539c01c502673fa8b718c7d0ba1
BLAKE2b-256 checksum
How to use checksums
24a5ae8cf60ebb2a20989a0cbc54c4406ae3743af26831be8ef2c24012a65788
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / apimatic_sticky_apis_sdk-0.0.1-py3-none-any.whl

Download URL apimatic_sticky_apis_sdk-0.0.1-py3-none-any.whl
Size 1.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
d5cb3e1210f2b22451b09401782141145d452b9be0a441f38429d9a6e22d983b
BLAKE2b-256 checksum
How to use checksums
7c82b0cacd2cb77774d762511d52c56f5aee9426ec3d1ac1115037223a847516
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for apimatic-sticky-apis-sdk 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page