shell/data-and-reporting-sdk

Data And Reporting product consists of API's which provides details of transaction and invoice informations about shell cards. The Shell Card Transaction and Invoice API is REST-based and employs Basic authentication in Version 1 and Oauth authentication in Version 2 end points. The API endpoints ac

2.0.0 2025-08-26 09:57 UTC

Requires

• php: ^7.2 || ^8.0
• ext-curl: *
• ext-json: *
• apimatic/core: ~0.3.13
• apimatic/core-interfaces: ~0.1.5
• apimatic/unirest-php: ^4.0.6

Requires (Dev)

• phan/phan: 5.4.5
• phpunit/phpunit: ^7.5 || ^8.5 || ^9.5
• squizlabs/php_codesniffer: ^3.5

MIT

• developer sdksio

• shell
• apis
• apimatic
• SDKs
• DataAndReporting

README

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

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "shell/data-and-reporting-sdk:2.0.0"

Or add it to the composer.json file manually as given below:

"require": {
    "shell/data-and-reporting-sdk": "2.0.0"
}

You can also view the package at: https://packagist.org/packages/shell/data-and-reporting-sdk#2.0.0

Test the SDK

Unit tests in this SDK can be run using PHPUnit.

1. First install the dependencies using composer including the require-dev dependencies.
2. Run vendor\bin\phpunit --verbose from commandline to execute tests. If you have installed PHPUnit globally, run tests using phpunit --verbose instead.

You can change the PHPUnit test configuration in the phpunit.xml file.

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
timeout	int	Timeout for API calls in seconds. Default: 0
enableRetries	bool	Whether to enable retries and backoff feature. Default: false
numberOfRetries	int	The number of retries to make. Default: 0
retryInterval	float	The retry time interval between the endpoint calls. Default: 1
backOffFactor	float	Exponential backoff factor to increase interval between retries. Default: 2
maximumRetryWaitTime	int	The maximum wait time in seconds for overall retrying requests. Default: 0
retryOnTimeout	bool	Whether to retry on request timeout. Default: true
httpStatusCodesToRetry	array	Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524
httpMethodsToRetry	array	Http methods to retry against. Default: 'GET', 'PUT'
proxyConfiguration	ProxyConfigurationBuilder	Represents the proxy configurations for API calls
clientCredentialsAuth	ClientCredentialsAuth	The Credentials Setter for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

use ShellDataReportingAPIsLib\Environment;
use ShellDataReportingAPIsLib\Authentication\ClientCredentialsAuthCredentialsBuilder;
use ShellDataReportingAPIsLib\ShellDataReportingAPIsClientBuilder;

$client = ShellDataReportingAPIsClientBuilder::init()
    ->clientCredentialsAuthCredentials(
        ClientCredentialsAuthCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
    )
    ->environment(Environment::SIT)
    ->build();

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

• ProxyConfigurationBuilder

HTTP

• HttpRequest
• HttpResponse

Utilities

• ApiException