shell / digital-payments-sdk
The APIs detailed within this SDK will enable Shell's Fleet Solutions Customers to digitalize Shell Card/s and use them to pay to refuel their vehicles at Shell Stations.
Requires
- php: ^7.2 || ^8.0
- ext-json: *
- apimatic/core: ~0.3.9
- apimatic/core-interfaces: ~0.1.5
- apimatic/unirest-php: ^4.0.0
Requires (Dev)
- phan/phan: 5.4.2
- phpunit/phpunit: ^7.5 || ^8.5 || ^9.5
- squizlabs/php_codesniffer: ^3.5
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 usingphpunit --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:
$client = ShellEVClientBuilder::init() ->mppTokenCredentials( MppTokenCredentialsBuilder::init( 'Authorization' ) ) ->oAuthTokenPostCredentials( OAuthTokenPostCredentialsBuilder::init( 'X-Apigee-Authorization' ) ) ->build();
Authorization
This API uses the following authentication schemes.
List of APIs
- Shell API Platform Security Authentication
- Digital Payment Enablement
- Station Locator
- Partner Notification
- Fueling