apimatic-cp-sdk 0.0.1

Sample SDK for CP

Getting Started with CellPoint API

Introduction

Service for interacting with CellPoint Digital's Payment Orchestration Platform (POP).

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-cp-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/apimatic-cp-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: 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, 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", "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
cpd_issued_jwt_credentials	CpdIssuedJwtCredentials	The credential object for OAuth 2 Client Credentials Grant
merchant_issued_jwt_credentials	MerchantIssuedJwtCredentials	The credential object for OAuth 2 Bearer token

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from cellpointapi.cellpointapi_client import CellpointapiClient
from cellpointapi.configuration import Environment
from cellpointapi.http.auth.cpd_issued_jwt import CpdIssuedJwtCredentials
from cellpointapi.http.auth.merchant_issued_jwt import MerchantIssuedJwtCredentials
from cellpointapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from cellpointapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from cellpointapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from cellpointapi.models.oauth_scope_cpd_issued_jwt import OauthScopeCpdIssuedJwt

client = CellpointapiClient(
    cpd_issued_jwt_credentials=CpdIssuedJwtCredentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret',
        oauth_scopes=[
            OauthScopeCpdIssuedJwt.BUYER,
            OauthScopeCpdIssuedJwt.DASHBOARDSVIEW
        ]
    ),
    merchant_issued_jwt_credentials=MerchantIssuedJwtCredentials(
        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 cellpointapi.cellpointapi_client import CellpointapiClient

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

• cpdIssuedJWT (OAuth 2 Client Credentials Grant)
• merchantIssuedJWT (OAuth 2 Bearer token)

List of APIs

• Apple Pay
• Payment Methods
• Authentication
• Bulk
• Cards
• Notes
• Orders
• Proxy
• Transactions
• Wallet

SDK Infrastructure

Configuration

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

HTTP

• HttpResponse
• HttpRequest
• Request

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime