Skip to main content

Getting Started with splitit-web-api-v4

Introduction

Splitit Orchestration API for managing installment plans.

Install the Package

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

pip install splitit-apimatic-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/splitit-apimatic-sdk/1.0.0

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.SANDBOX
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.
o_auth_2_credentials OAuth2Credentials The credential object for OAuth 2 Client Credentials Grant
api_key_credentials ApiKeyCredentials The credential object for Custom Header Signature

The API client can be initialized as follows:

Code-Based Client Initialization

from splititwebapiv4.configuration import Environment
from splititwebapiv4.http.auth.api_key import ApiKeyCredentials
from splititwebapiv4.http.auth.o_auth_2 import OAuth2Credentials
from splititwebapiv4.models.o_auth_scope_o_auth_2_enum import OAuthScopeOAuth2Enum
from splititwebapiv4.splititwebapiv_4_client import Splititwebapiv4Client

client = Splititwebapiv4Client(
    o_auth_2_credentials=OAuth2Credentials(
        o_auth_client_id='OAuthClientId',
        o_auth_client_secret='OAuthClientSecret',
        o_auth_scopes=[
            OAuthScopeOAuth2Enum.API_V4
        ]
    ),
    api_key_credentials=ApiKeyCredentials(
        x_splitit_api_key='X-Splitit-Api-Key'
    ),
    environment=Environment.SANDBOX
)

Environment-Based Client Initialization

from splititwebapiv4.splititwebapiv_4_client import Splititwebapiv4Client

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = Splititwebapiv4Client.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
SANDBOX Default Sandbox Environment (Transactional API)
PRODUCTION Production Environment (Transactional API)

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for splitit-apimatic-sdk 1.0.0

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

Source distribution (sdist)

Source distribution for splitit-apimatic-sdk 1.0.0
File Size Uploaded Provenance Actions
splitit_apimatic_sdk-1.0.0.tar.gz 51.8 kB Without provenance Details for splitit_apimatic_sdk-1.0.0.tar.gz

Built distribution (wheel)

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

Total release size: 164.4 kB

Release files / splitit_apimatic_sdk-1.0.0.tar.gz

Download URL splitit_apimatic_sdk-1.0.0.tar.gz
Size 51.8 kB
Tags Source
SHA-256 checksum
How to use checksums
e1c069ed87ace0f6140158beaccdb4d3976090880505827214868e05d80cadcd
BLAKE2b-256 checksum
How to use checksums
e18568edaa24f15c54580470509abe580e2a443085f53a082cd5f8c8fec6c745
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / splitit_apimatic_sdk-1.0.0-py3-none-any.whl

Download URL splitit_apimatic_sdk-1.0.0-py3-none-any.whl
Size 112.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8ed98e906c75caf815391dfc082c3a4e4e79ed2dfd57b7e91530ce411d13f8e9
BLAKE2b-256 checksum
How to use checksums
2bec25c6f19a64bb91d5a8a519dd849bfdb7f7412d82b0837fbccb962e4197e4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for splitit-apimatic-sdk 1.0.0

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

1.0.0 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