data-and-reporting-sdk 3.0.0

Data And Reporting product consists of API's which provides details of transaction and invoice informations about shell cards.

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 POST HTTP 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.

• BearerToken (OAuth 2 Client Credentials Grant)

List of APIs

• Customer
• Transaction
• Invoice

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime