README

Introduction

The APIs detailed within this document will enable Shell's Fleet Solutions Customers to digitalize Shell Card/s and use them to pay to refuel their vehicles at Shell Stations.

Install the Package

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

composer require "shell/digital-payments-sdk:1.0.0"

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

"require": {
    "shell/digital-payments-sdk": "1.0.0"
}

You can also view the package at: https://packagist.org/packages/shell/digital-payments-sdk#1.0.0

Test the SDK

Unit tests in this SDK can be run using PHPUnit.

First install the dependencies using composer including the require-dev dependencies.
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
`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'`
`mppTokenCredentials`	`MppTokenCredentials`	The Credentials Setter for Custom Header Signature
`oAuthTokenPostCredentials`	`OAuthTokenPostCredentials`	The Credentials Setter for Custom Header Signature

The API client can be initialized as follows:

$client = ShellEVClientBuilder::init()
    ->mppTokenCredentials(
        MppTokenCredentialsBuilder::init(
            'Authorization'
        )
    )
    ->oAuthTokenPostCredentials(
        OAuthTokenPostCredentialsBuilder::init(
            'X-Apigee-Authorization'
        )
    )
    ->build();

Authorization

This API uses the following authentication schemes.

shell / digital-payments-sdk

Maintainers

Details