Getting Started with Shell Card Management APIs
Introduction
The Shell Card Management API provides secure and structured access to the Shell Card Platform, enabling integration with Shell’s internal systems for managing card-related resources.
This REST-based API uses the POST method for all operations—including retrieval, creation, update, and deletion of resources. It supports flexible search capabilities through JSON-encoded request bodies and returns JSON-formatted responses. Standard HTTP status codes are used to indicate the outcome of each request.
Authentication is handled via OAuth 2.0 using the Client Credentials flow. Access tokens must be included in the Authorization header of each request.
All resources are managed within the Shell Card Platform, which abstracts the complexity of backend systems. Some operations may be processed asynchronously, and clients should be prepared to handle delayed responses or polling mechanisms where applicable.
Go to the Shell Developer Portal: https://developer.shell.com
Install the Package
The package is compatible with Python versions 3.7+.
Install the package from PyPi using the following pip command:
pip install card-management-sdk==3.0.0
You can also view the package at: https://pypi.python.org/pypi/card-management-sdk/3.0.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.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: 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. |
| client_credentials_auth_credentials | ClientCredentialsAuthCredentials |
The credential object for OAuth 2 Client Credentials Grant |
The API client can be initialized as follows:
Code-Based Client Initialization
from shellcardmanagementapis.configuration import Environment
from shellcardmanagementapis.http.auth.o_auth_2 import ClientCredentialsAuthCredentials
from shellcardmanagementapis.shellcardmanagementapis_client import ShellcardmanagementapisClient
client = ShellcardmanagementapisClient(
client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
o_auth_client_id='OAuthClientId',
o_auth_client_secret='OAuthClientSecret'
),
environment=Environment.SIT
)
Environment-Based Client Initialization
from shellcardmanagementapis.shellcardmanagementapis_client import ShellcardmanagementapisClient
# Specify the path to your .env file if it’s located outside the project’s root directory.
client = ShellcardmanagementapisClient.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 | - |
Authorization
This API uses the following authentication schemes.
List of APIs
SDK Infrastructure
Configuration
HTTP
Utilities
Metadata
Release files for card-management-sdk 3.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| card_management_sdk-3.0.0.tar.gz | 228.9 kB | Without provenance | Details for card_management_sdk-3.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| card_management_sdk-3.0.0-py3-none-any.whl | Python 3 | none | any | Details for card_management_sdk-3.0.0-py3-none-any.whl |
Total release size: 646.7 kB
Release files / card_management_sdk-3.0.0.tar.gz
| Download URL | card_management_sdk-3.0.0.tar.gz |
|---|---|
| Size | 228.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
33d6fac5164ff683c9803040a4afef966bf7c58b3e1652d485715efde88399d4
|
|
BLAKE2b-256 checksum How to use checksums |
bab11f97772df50e68a8312694dc79c0a854bc71b828d886d6305e1cfd71c29e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Release files / card_management_sdk-3.0.0-py3-none-any.whl
| Download URL | card_management_sdk-3.0.0-py3-none-any.whl |
|---|---|
| Size | 417.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e06cd0d39604a946cf69ad321beaa13224a3f5a0bd2608695b666290f94f7da3
|
|
BLAKE2b-256 checksum How to use checksums |
4688df663f14d98de4d2d5dbb5c0a6cce9c5e996467f7ae88654830b8fdb3704
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Security for card-management-sdk 3.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.