Skip to main content

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.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for apimatic-cp-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-cp-sdk 0.0.1
File Size Uploaded Provenance Actions
apimatic_cp_sdk-0.0.1.tar.gz 165.8 kB Without provenance Details for apimatic_cp_sdk-0.0.1.tar.gz

Built distribution (wheel)

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

Total release size: 613.3 kB

Release files / apimatic_cp_sdk-0.0.1.tar.gz

Download URL apimatic_cp_sdk-0.0.1.tar.gz
Size 165.8 kB
Tags Source
SHA-256 checksum
How to use checksums
79076c426f51322ca71c9f7a2d43b03ec965966a33f417e3a21ba260a30a1a31
BLAKE2b-256 checksum
How to use checksums
e2505bb6bff942408e6b11b0310e8c338fcac885f733ddbed35059202d374f98
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

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

Download URL apimatic_cp_sdk-0.0.1-py3-none-any.whl
Size 447.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b68c606fd3290760f44fc028c6b906e04e2a549b06296c1dcae23f07b2296d61
BLAKE2b-256 checksum
How to use checksums
4081acdeb247bbd474918cfd6ea1a5c9153975d2e999c847d265630837b54562
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for apimatic-cp-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