The Shell Card Management API is REST-based and employs OAUTH 2.0,Basic and ApiKey authentication. The API endpoints accept JSON-encoded request bodies, return JSON-encoded responses and use standard HTTP response codes.
Project description
Getting Started with Shell Card Management APIs
Introduction
The Shell Card Management API is REST-based and employs OAUTH 2.0,Basic and ApiKey authentication.
The API endpoints accept JSON-encoded request bodies, return JSON-encoded responses and use standard HTTP response codes.
All resources are located in the Shell Card Platform. The Shell Card Platform is the overall platform that encompasses all the internal Shell systems used to manage resources.
The internal workings of the platform are not important when interacting with the API. However, it is worth noting that the platform uses a microservice architecture to communicate with various backend systems and some API calls are processed asynchronously.
All endpoints use the POST
verb for retrieving, updating, creating and deleting resources in the Shell Card Platform. The endpoints that retrieve resources from the Shell Card Platform allow flexible search parameters in the API request body.
Go to the Shell Developer Portal: https://developer.shell.com
Install the Package
The package is compatible with Python versions 3 >=3.7, <= 3.11
.
Install the package from PyPi using the following pip command:
pip install card-management-sdk==1.1.0
You can also view the package at: https://pypi.python.org/pypi/card-management-sdk/1.1.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.SIT |
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'] |
basic_auth_credentials |
BasicAuthCredentials |
The credential object for Basic Authentication |
bearer_token_credentials |
BearerTokenCredentials |
The credential object for OAuth 2 Client Credentials Grant |
The API client can be initialized as follows:
client = ShellcardmanagementapisClient(
basic_auth_credentials=BasicAuthCredentials(
username='Username',
password='Password'
),
bearer_token_credentials=BearerTokenCredentials(
o_auth_client_id='OAuthClientId',
o_auth_client_secret='OAuthClientSecret'
)
)
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
Classes Documentation
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for card_management_sdk-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f257b7f53d3b978c49a18bd37afdbcbabe3626f5ae8af14fcf5c50696d5b799 |
|
MD5 | 952c584e3193eaed69fcbe2108c8ea3b |
|
BLAKE2b-256 | eb8b25ca90774ceb91ec6b8dfd23d63a521ec95e3e4ee282a29385cb7fb69d29 |
Hashes for card_management_sdk-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5e3b68247da753da9135a23c9d7ef3af8e3e2bce9319fb59e86c3a67f8a1344 |
|
MD5 | 6740527efbc01f8f442b81597eca5e5d |
|
BLAKE2b-256 | a8b890f9c4d759f8cb68985989d9b0123babc5c0ad225599e8b896ce5ef41991 |