Digital-payments-sdk NPM

Getting Started with Shell SmartPay API

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 from your project directory to install the package from npm:

npm install digital-payments-sdk@1.1.0

For additional package details, see the Npm page for the digital-payments-sdk@1.1.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.Test`
`timeout`	`number`	Timeout for API calls.Default: `0`
`httpClientOptions`	`Partial<HttpClientOptions>`	Stable configurable http client options.
`unstableHttpClientOptions`	`any`	Unstable configurable http client options.
`mppTokenCredentials`	`MppTokenCredentials`	The credential object for mppToken
`oAuthTokenPostCredentials`	`OAuthTokenPostCredentials`	The credential object for oAuthTokenPost

HttpClientOptions

Parameter	Type	Description
`timeout`	`number`	Timeout in milliseconds.
`httpAgent`	`any`	Custom http agent to be used when performing http requests.
`httpsAgent`	`any`	Custom https agent to be used when performing http requests.
`retryConfig`	`Partial<RetryConfiguration>`	Configurations to retry requests.

RetryConfiguration

Parameter	Type	Description
`maxNumberOfRetries`	`number`	Maximum number of retries. Default: `0`
`retryOnTimeout`	`boolean`	Whether to retry on request timeout. Default: `true`
`retryInterval`	`number`	Interval before next retry. Used in calculation of wait time for next request in case of failure. Default: `1`
`maximumRetryWaitTime`	`number`	Overall wait time for the requests getting retried. Default: `0`
`backoffFactor`	`number`	Used in calculation of wait time for next request in case of failure. Default: `2`
`httpStatusCodesToRetry`	`number[]`	Http status codes to retry against. Default: `[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]`
`httpMethodsToRetry`	`HttpMethod[]`	Http methods to retry against. Default: `['GET', 'PUT']`

The API client can be initialized as follows:

const client = new Client({
  mppTokenCredentials: {
    'Authorization': 'Authorization'
  },
  oAuthTokenPostCredentials: {
    'X-Apigee-Authorization': 'X-Apigee-Authorization'
  },
  timeout: 0,
  environment: Environment.Test,
});

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name	Description
Test	Default
Production	-

Authorization

This API uses the following authentication schemes.

List of APIs

Classes Documentation

Shell APIMatic SDKs APIs DigitalPayments

@apimatic/authentication-adapters @apimatic/axios-client-adapter @apimatic/core @apimatic/schema

1.1.0

6 months ago

1.0.0

1 year ago