Getting Started with Shell EV

Introduction

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.

Supported Function

  • Start a charging session
  • Stop a charging session
  • Retrieve the status of a charging session
  • Retrieve the list of all active sessions for a card termsOfService: 'https://developer.shell.com/terms-of-use'

Go to the Shell Developer Portal: https://developer.shell.com

Install the Package

Install the gem from the command line:

gem install ev-recharge-sdk -v 1.0.0

Or add the gem to your Gemfile and run bundle:

gem 'ev-recharge-sdk', '1.0.0'

For additional gem details, see the RubyGems page for the ev-recharge-sdk gem.

Test the SDK

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

rake

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
env EnvEnum This variable specifies the type of environment. Environments:

* api - Production
* api-test - UAT
Default: EnvEnum::ENUM_APITESTSHELLCOM
environment Environment The API environment.
Default: Environment.PRODUCTION
connection Faraday::Connection The Faraday connection object passed by the SDK user for making requests
adapter Faraday::Adapter The Faraday adapter object passed by the SDK user for performing http requests
timeout Float The value to use for connection timeout.
Default: 60
max_retries Integer The number of times to retry an endpoint call if it fails.
Default: 0
retry_interval Float Pause in seconds between retries.
Default: 1
backoff_factor Float The amount to multiply each successive retry's interval amount by in order to provide backoff.
Default: 2
retry_statuses Array A list of HTTP statuses to retry.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array A list of HTTP methods to retry.
Default: %i[get put]
http_callback HttpCallBack The Http CallBack allows defining callables for pre and post API calls.
client_credentials_auth_credentials ClientCredentialsAuthCredentials The credential object for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

client = ShellEv::Client.new(
  client_credentials_auth_credentials: ClientCredentialsAuthCredentials.new(
    o_auth_client_id: 'OAuthClientId',
    o_auth_client_secret: 'OAuthClientSecret'
  ),
  environment: Environment::PRODUCTION,
  env: EnvEnum::ENUM_APITESTSHELLCOM
)

Authorization

This API uses the following authentication schemes.

List of APIs

Classes Documentation