Skip to main content

Getting Started with Loyalty APIs

Introduction

Loyalty Account Management provides the end points needed in order to generate the user Authorization Tokens which will provide access to the Loyalty APIs and also to update the user profile.

Install the Package

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

pip install loyalty-sdk==0.0.3

You can also view the package at: https://pypi.python.org/pypi/loyalty-sdk/0.0.3

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.SIT
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: 30
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
public_bearer_token_credentials PublicBearerTokenCredentials The credential object for OAuth 2 Bearer token
public_basic_token_credentials PublicBasicTokenCredentials The credential object for Custom Header Signature
private_basic_token_credentials PrivateBasicTokenCredentials The credential object for Custom Header Signature
client_authorization_token_credentials ClientAuthorizationTokenCredentials The credential object for OAuth 2 Client Credentials Grant
customer_header_credentials CustomerHeaderCredentials The credential object for Custom Header Signature

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from loyaltyapis.configuration import Environment
from loyaltyapis.http.auth.client_authorization_token import ClientAuthorizationTokenCredentials
from loyaltyapis.http.auth.customer_header import CustomerHeaderCredentials
from loyaltyapis.http.auth.private_basic_token import PrivateBasicTokenCredentials
from loyaltyapis.http.auth.public_basic_token import PublicBasicTokenCredentials
from loyaltyapis.http.auth.public_bearer_token import PublicBearerTokenCredentials
from loyaltyapis.logging.configuration.api_logging_configuration import LoggingConfiguration
from loyaltyapis.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from loyaltyapis.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from loyaltyapis.loyaltyapis_client import LoyaltyapisClient

client = LoyaltyapisClient(
    public_bearer_token_credentials=PublicBearerTokenCredentials(
        access_token='AccessToken'
    ),
    public_basic_token_credentials=PublicBasicTokenCredentials(
        public_basic_token='Public Basic Token'
    ),
    private_basic_token_credentials=PrivateBasicTokenCredentials(
        public_basic_token='Public Basic Token'
    ),
    client_authorization_token_credentials=ClientAuthorizationTokenCredentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret'
    ),
    customer_header_credentials=CustomerHeaderCredentials(
        authorization_token='Authorization-Token'
    ),
    environment=Environment.SIT,
    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 loyaltyapis.loyaltyapis_client import LoyaltyapisClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = LoyaltyapisClient.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
SIT Default
PRODUCTION -
UAT -

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for loyalty-sdk 0.0.3

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

Source distribution (sdist)

Source distribution for loyalty-sdk 0.0.3
File Size Uploaded Provenance Actions
loyalty_sdk-0.0.3.tar.gz 56.0 kB Without provenance Details for loyalty_sdk-0.0.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for loyalty-sdk 0.0.3
File Interpreter ABI Platform Actions
loyalty_sdk-0.0.3-py3-none-any.whl Python 3 none any Details for loyalty_sdk-0.0.3-py3-none-any.whl

Total release size: 194.9 kB

Release files / loyalty_sdk-0.0.3.tar.gz

Download URL loyalty_sdk-0.0.3.tar.gz
Size 56.0 kB
Tags Source
SHA-256 checksum
How to use checksums
5ffe32ba6f2f7760fc6492b9e247eb0e7847152e25155c612f7f68299af85755
BLAKE2b-256 checksum
How to use checksums
e0c36e0143ec985350fac3e449885ace3fc1e9d32d67747b176835ca1e58df3c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / loyalty_sdk-0.0.3-py3-none-any.whl

Download URL loyalty_sdk-0.0.3-py3-none-any.whl
Size 138.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
62ad88d29c746aada3eb14365e5a1cbed3f01327aab907ea1650cfcf8714b63e
BLAKE2b-256 checksum
How to use checksums
268f3280d719793f39417d402c13da6623e973c91ff60718d62e361471984033
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for loyalty-sdk 0.0.3

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.

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