Skip to main content

Getting Started with Shell SmartPay API

Introduction

The APIs detailed within this document will enable Shell's Fleet Solutions Customers to digitalize Shell Card/s and use them to pay to refuel their vehicles at Shell Stations.

Install the Package

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

pip install digital-payments-sdk==1.2.0

You can also view the package at: https://pypi.python.org/pypi/digital-payments-sdk/1.2.0

Test the SDK

You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands

pip install -r test-requirements.txt
pytest

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.TEST
http_client_instance HttpClient 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']
mpp_token_credentials MppTokenCredentials The credential object for Custom Header Signature
o_auth_token_post_credentials OAuthTokenPostCredentials The credential object for Custom Header Signature

The API client can be initialized as follows:

client = ShellsmartpayapiClient(
    mpp_token_credentials=MppTokenCredentials(
        authorization='Authorization'
    ),
    o_auth_token_post_credentials=OAuthTokenPostCredentials(
        x_apigee_authorization='X-Apigee-Authorization'
    ),
    environment=Environment.TEST
)

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name Description
Test Default
Production -

Authorization

This API uses the following authentication schemes.

List of APIs

Classes Documentation

Metadata

Release files for digital-payments-sdk 1.2.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 digital-payments-sdk 1.2.0
File Size Uploaded Provenance Actions
digital_payments_sdk-1.2.0.tar.gz 33.1 kB Without provenance Details for digital_payments_sdk-1.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for digital-payments-sdk 1.2.0
File Interpreter ABI Platform Actions
digital_payments_sdk-1.2.0-py3-none-any.whl Python 3 none any Details for digital_payments_sdk-1.2.0-py3-none-any.whl

Total release size: 104.0 kB

Release files / digital_payments_sdk-1.2.0.tar.gz

Download URL digital_payments_sdk-1.2.0.tar.gz
Size 33.1 kB
Tags Source
SHA-256 checksum
How to use checksums
f0dd4b53c89fae759cdc17349df98c6891072863010844eac3593b1c509aacb8
BLAKE2b-256 checksum
How to use checksums
049113a3cd6f624d41aa31486b203083248d98861c21a022057b100d048480e5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.13

Release files / digital_payments_sdk-1.2.0-py3-none-any.whl

Download URL digital_payments_sdk-1.2.0-py3-none-any.whl
Size 70.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1fca88727fae7fd3fd34ef244ca1ff06d72afff06f14c9de7af2fc3108ca32b8
BLAKE2b-256 checksum
How to use checksums
c3744d937dc52d881b153ea8eb062dc9b25a43953ae6f6842dd97d3381edeaef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.13

Security for digital-payments-sdk 1.2.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.

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