loyalty-sdk 0.0.3

Loyalty APIs provides the end points needed in order to generate the user Authorization Tokens, manage offers assigned to a user, and retrieve the Loyalty Points balance of users.

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.

• PublicBearerToken (OAuth 2 Bearer token)
• PublicBasicToken (Custom Header Signature)
• PrivateBasicToken (Custom Header Signature)
• client-authorization-token (OAuth 2 Client Credentials Grant)
• customerHeader (Custom Header Signature)

List of APIs

• Profile Management
• Authorization
• Offer
• Balances
• Redemption
• Transaction

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime