shell / ev-recharge-sdk
This API Product provides the option to manage charging at all public Shell Recharge locations. The end points provides control to start, stop and get status of the charging session.
Requires
- php: ^7.2 || ^8.0
- ext-json: *
- apimatic/core: ~0.3.11
- 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
This API Product provides the list of all Shell Recharge locations. The list includes all Shell Recharge network and all locations available through our roaming partners.
Supported Functions
- Get the list of all the locations and its details.
- Get the details of a particular location.
- Get the list of locations nearby using the latitude and longitude.
- Get the list of locations for a given set of bounds with different zoom levels.
The Charging endpoints provides control to start, stop and get status of the charging session.
Supported Functions
- Start a charging session\n
- Stop a charging session \n
- Retrieve the status of a charging session \n
- Retrieve the list of all active sessions for a card
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/ev-recharge-sdk:1.2.0"
Or add it to the composer.json file manually as given below:
"require": { "shell/ev-recharge-sdk": "1.2.0" }
You can also view the package at: https://packagist.org/packages/shell/ev-recharge-sdk#1.2.0
Test the SDK
Unit tests in this SDK can be run using PHPUnit.
- First install the dependencies using composer including the
require-devdependencies. - Run
vendor\bin\phpunit --verbosefrom commandline to execute tests. If you have installed PHPUnit globally, run tests usingphpunit --verboseinstead.
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() ->clientCredentialsAuthCredentials( ClientCredentialsAuthCredentialsBuilder::init( 'OAuthClientId', 'OAuthClientSecret' ) ) ->environment('production') ->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.