Getting Started with Shell Data & Reporting APIs
Introduction
The Shell Card Transaction and Invoice API is part of the Data and Reporting product suite, designed to provide secure and flexible access to transaction and invoice data related to Shell Cards.
Authentication
- OAuth 2.0 Authentication.
Architecture
- RESTful API design.
- All endpoints use the
POSTHTTP method for all operations including retrieval, creation, update, and deletion of resources. - Requests and responses are encoded in JSON format.
- Standard HTTP status codes are used for response handling.
Platform
- All resources are managed within the Shell Card Platform, which integrates multiple internal Shell systems for resource management.
Features
- Flexible search parameters supported in the request body for data retrieval.
- Designed for integration with enterprise systems requiring Shell Card transaction and invoice data.
Use Cases
- Retrieve detailed transaction history for Shell Cards.
- Access invoice summaries and line-item details.
- Integrate Shell Card financial data into internal reporting tools.
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 data-and-reporting-sdk==3.0.0
You can also view the package at: https://pypi.python.org/pypi/data-and-reporting-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 shelldatareportingapis.configuration import Environment
from shelldatareportingapis.http.auth.o_auth_2 import ClientCredentialsAuthCredentials
from shelldatareportingapis.shelldatareportingapis_client import ShelldatareportingapisClient
client = ShelldatareportingapisClient(
client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
o_auth_client_id='OAuthClientId',
o_auth_client_secret='OAuthClientSecret'
),
environment=Environment.SIT
)
Environment-Based Client Initialization
from shelldatareportingapis.shelldatareportingapis_client import ShelldatareportingapisClient
# Specify the path to your .env file if it’s located outside the project’s root directory.
client = ShelldatareportingapisClient.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 data-and-reporting-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 |
|---|---|---|---|---|
| data_and_reporting_sdk-3.0.0.tar.gz | 296.1 kB | Without provenance | Details for data_and_reporting_sdk-3.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| data_and_reporting_sdk-3.0.0-py3-none-any.whl | Python 3 | none | any | Details for data_and_reporting_sdk-3.0.0-py3-none-any.whl |
Total release size: 935.2 kB
Release files / data_and_reporting_sdk-3.0.0.tar.gz
| Download URL | data_and_reporting_sdk-3.0.0.tar.gz |
|---|---|
| Size | 296.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
81b522989392756b14cce193291ab248f232d39233e8eadb50a568096d04a48d
|
|
BLAKE2b-256 checksum How to use checksums |
8d476e2f03b68e8cf7bb69eccf16dba25e19b6702119fb381e238fb131973812
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Release files / data_and_reporting_sdk-3.0.0-py3-none-any.whl
| Download URL | data_and_reporting_sdk-3.0.0-py3-none-any.whl |
|---|---|
| Size | 639.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0b3486d20d9291532a21d4bdfacec79d015526b8d60d552bc698a7b2b7725774
|
|
BLAKE2b-256 checksum How to use checksums |
628a8ba47d1ff4fdde9a778ca1e999dd54a29b96ddc8e9ba059df5ee8db874d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Security for data-and-reporting-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.