Getting Started with Shell Card Management APIs

Introduction

The Shell Card Management API is REST-based and employs OAUTH 2.0,Basic and ApiKey authentication. The API endpoints accept JSON-encoded request bodies, return JSON-encoded responses and use standard HTTP response codes.
All resources are located in the Shell Card Platform. The Shell Card Platform is the overall platform that encompasses all the internal Shell systems used to manage resources. The internal workings of the platform are not important when interacting with the API. However, it is worth noting that the platform uses a microservice architecture to communicate with various backend systems and some API calls are processed asynchronously. All endpoints use the POST verb for retrieving, updating, creating and deleting resources in the Shell Card Platform. The endpoints that retrieve resources from the Shell Card Platform allow flexible search parameters in the API request body.

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/card-management-sdk:1.1.0"

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

"require": {
    "shell/card-management-sdk": "1.1.0"
}

You can also view the package at: https://packagist.org/packages/shell/card-management-sdk#1.1.0

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.SIT
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'
basicAuthCredentials	BasicAuthCredentials	The Credentials Setter for Basic Authentication
bearerTokenCredentials	BearerTokenCredentials	The Credentials Setter for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

$client = ShellCardManagementAPIsClientBuilder::init()
    ->basicAuthCredentials(
        BasicAuthCredentialsBuilder::init(
            'Username',
            'Password'
        )
    )
    ->bearerTokenCredentials(
        BearerTokenCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
    )
    ->environment('SIT')
    ->build();

Environments

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

Fields

Name	Description
SIT	Default
Production	-

Authorization

This API uses the following authentication schemes.

• BasicAuth (Basic Authentication)
• BearerToken (OAuth 2 Client Credentials Grant)

List of APIs

• O Auth Authorization
• Customer
• Restriction
• Card

Classes Documentation

• ApiException
• HttpRequest
• HttpResponse