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:3.0.0"

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

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

You can also view the package at: https://packagist.org/packages/shell/data-and-reporting-sdk#3.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:

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

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