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

Run the following command from your project directory to install the package from npm:

npm install data-and-reporting-sdk@2.0.0

For additional package details, see the Npm page for the data-and-reporting-sdk@2.0.0 npm.

Test the SDK

To validate the functionality of this SDK, you can execute all tests located in the test directory. This SDK utilizes Jest as both the testing framework and test runner.

To run the tests, navigate to the root directory of the SDK and execute the following command:

npm run test

Or you can also run tests with coverage report:

npm run test:coverage

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	number	Timeout for API calls. Default: 0
httpClientOptions	Partial<HttpClientOptions>	Stable configurable http client options.
unstableHttpClientOptions	any	Unstable configurable http client options.
clientCredentialsAuthCredentials	ClientCredentialsAuthCredentials	The credential object for clientCredentialsAuth

The API client can be initialized as follows:

import { Client, Environment } from 'data-and-reporting-sdk';

const client = new Client({
  clientCredentialsAuthCredentials: {
    oAuthClientId: 'OAuthClientId',
    oAuthClientSecret: 'OAuthClientSecret'
  },
  timeout: 0,
  environment: Environment.SIT,
});

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

• HttpClientOptions
• RetryConfiguration
• ProxySettings

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError