Download the PHP package shell/card-management-sdk without Composer
On this page you can find all versions of the php package shell/card-management-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download shell/card-management-sdk
More information about shell/card-management-sdk
Files in shell/card-management-sdk
Package card-management-sdk
Short Description 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.
License MIT
Homepage https://www.shell.com/
Informations about the package card-management-sdk
Getting Started with Shell Card Management APIs
Introduction
The Shell Card Management API provides secure and structured access to the Shell Card Platform, enabling integration with Shell’s internal systems for managing card-related resources.
This REST-based API uses the POST method for all operations—including retrieval, creation, update, and deletion of resources. It supports flexible search capabilities through JSON-encoded request bodies and returns JSON-formatted responses. Standard HTTP status codes are used to indicate the outcome of each request.
Authentication is handled via OAuth 2.0 using the Client Credentials flow. Access tokens must be included in the Authorization header of each request.
All resources are managed within the Shell Card Platform, which abstracts the complexity of backend systems. Some operations may be processed asynchronously, and clients should be prepared to handle delayed responses or polling mechanisms where applicable.
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:
Or add it to the composer.json file manually as given below:
You can also view the package at: https://packagist.org/packages/shell/card-management-sdk#2.0.1
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:
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' |
proxyConfiguration | ProxyConfigurationBuilder |
Represents the proxy configurations for API calls |
clientCredentialsAuth | ClientCredentialsAuth |
The Credentials Setter for OAuth 2 Client Credentials Grant |
The API client can be initialized as follows:
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.
List of APIs
SDK Infrastructure
Configuration
HTTP
Utilities
All versions of card-management-sdk with dependencies
ext-json Version *
ext-curl Version *
apimatic/unirest-php Version ^4.0.6
apimatic/core-interfaces Version ~0.1.5
apimatic/core Version ~0.3.13