PHPackages                             shell/data-and-reporting-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. shell/data-and-reporting-sdk

ActiveLibrary[CLI & Console](/categories/cli)

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

2.0.0(8mo ago)068MITPHPPHP ^7.2 || ^8.0

Since May 28Pushed 8mo agoCompare

[ Source](https://github.com/sdks-io/data-and-reporting-php-sdk)[ Packagist](https://packagist.org/packages/shell/data-and-reporting-sdk)[ Docs](https://www.shell.com/)[ RSS](/packages/shell-data-and-reporting-sdk/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (6)Versions (6)Used By (0)

Getting Started with Shell Data & Reporting APIs
====================================================

[](#getting-started-with-shell-data--reporting-apis)

Introduction
------------

[](#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

[](#authentication)

- OAuth 2.0 Authentication.

### Architecture

[](#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

[](#platform)

- All resources are managed within the **Shell Card Platform**, which integrates multiple internal Shell systems for resource management.

### Features

[](#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

[](#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:

Install the Package
-------------------

[](#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:

Test the SDK
------------

[](#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
-------------------------

[](#initialize-the-api-client)

***Note:*** Documentation for the client can be found [here.](https://www.github.com/sdks-io/data-and-reporting-php-sdk/tree/2.0.0/doc/client.md)

The following parameters are configurable for the API Client:

ParameterTypeDescriptionenvironment`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`](https://www.github.com/sdks-io/data-and-reporting-php-sdk/tree/2.0.0/doc/proxy-configuration-builder.md)Represents the proxy configurations for API callsclientCredentialsAuth[`ClientCredentialsAuth`](https://www.github.com/sdks-io/data-and-reporting-php-sdk/tree/2.0.0/doc/auth/oauth-2-client-credentials-grant.md)The Credentials Setter for OAuth 2 Client Credentials GrantThe 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
------------

[](#environments)

The SDK can be configured to use a different environment for making API calls. Available environments are:

### Fields

[](#fields)

NameDescriptionSIT**Default**Production-Authorization
-------------

[](#authorization)

This API uses the following authentication schemes.

- [`BearerToken (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/data-and-reporting-php-sdk/tree/2.0.0/doc/auth/oauth-2-client-credentials-grant.md)

List of APIs
------------

[](#list-of-apis)

- [Customer](https://www.github.com/sdks-io/data-and-reporting-php-sdk/tree/2.0.0/doc/controllers/customer.md)
- [Transaction](https://www.github.com/sdks-io/data-and-reporting-php-sdk/tree/2.0.0/doc/controllers/transaction.md)
- [Invoice](https://www.github.com/sdks-io/data-and-reporting-php-sdk/tree/2.0.0/doc/controllers/invoice.md)

SDK Infrastructure
------------------

[](#sdk-infrastructure)

### Configuration

[](#configuration)

- [ProxyConfigurationBuilder](https://www.github.com/sdks-io/data-and-reporting-php-sdk/tree/2.0.0/doc/proxy-configuration-builder.md)

### HTTP

[](#http)

- [HttpRequest](https://www.github.com/sdks-io/data-and-reporting-php-sdk/tree/2.0.0/doc/http-request.md)
- [HttpResponse](https://www.github.com/sdks-io/data-and-reporting-php-sdk/tree/2.0.0/doc/http-response.md)

### Utilities

[](#utilities)

- [ApiException](https://www.github.com/sdks-io/data-and-reporting-php-sdk/tree/2.0.0/doc/api-exception.md)

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance59

Moderate activity, may be stable

Popularity8

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~113 days

Total

5

Last Release

263d ago

Major Versions

1.3.0 → 2.0.02025-08-26

### Community

Maintainers

![](https://www.gravatar.com/avatar/ef06f97b4ff5db714f2a124525216538f97338487cd4e2bca22baa32c0bf90cd?d=identicon)[developer-sdksio](/maintainers/developer-sdksio)

---

Top Contributors

[![developer-sdksio](https://avatars.githubusercontent.com/u/135820708?v=4)](https://github.com/developer-sdksio "developer-sdksio (5 commits)")

---

Tags

shellapimaticapisSDKsDataAndReporting

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/shell-data-and-reporting-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/shell-data-and-reporting-sdk/health.svg)](https://phpackages.com/packages/shell-data-and-reporting-sdk)
```

###  Alternatives

[psy/psysh

An interactive shell for modern PHP.

9.8k545.6M719](/packages/psy-psysh)[mikehaertl/php-shellcommand

An object oriented interface to shell commands

32437.5M61](/packages/mikehaertl-php-shellcommand)[kevinlebrun/colors.php

Colors for PHP CLI scripts

3426.7M45](/packages/kevinlebrun-colorsphp)[square/square

Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.

793.4M21](/packages/square-square)[mrrio/shellwrap

Use any command-line tool as a PHP function.

738198.8k2](/packages/mrrio-shellwrap)[stepanenko3/nova-command-runner

Laravel Nova tool for running Artisan and bash(shell) commands.

36983.0k](/packages/stepanenko3-nova-command-runner)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)