Download the PHP package shell/loyalty-sdk without Composer
On this page you can find all versions of the php package shell/loyalty-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download shell/loyalty-sdk
More information about shell/loyalty-sdk
Files in shell/loyalty-sdk
Package loyalty-sdk
Short Description Loyalty APIs provides the end points needed in order to generate the user Authorization Tokens, manage offers assigned to a user, and retrieve the Loyalty Points balance of users.
License MIT
Homepage https://developer.shell.com/
Informations about the package loyalty-sdk
Getting Started with Loyalty APIs
Introduction
Loyalty Account Management provides the end points needed in order to generate the user Authorization Tokens which will provide access to the Loyalty APIs and also to update the user profile.
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/loyalty-sdk#0.0.3
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: 30 |
| 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' |
| loggingConfiguration | LoggingConfigurationBuilder |
Represents the logging configurations for API calls |
| proxyConfiguration | ProxyConfigurationBuilder |
Represents the proxy configurations for API calls |
| publicBearerTokenCredentials | PublicBearerTokenCredentials |
The Credentials Setter for OAuth 2 Bearer token |
| publicBasicTokenCredentials | PublicBasicTokenCredentials |
The Credentials Setter for Custom Header Signature |
| privateBasicTokenCredentials | PrivateBasicTokenCredentials |
The Credentials Setter for Custom Header Signature |
| clientAuthorizationTokenCredentials | ClientAuthorizationTokenCredentials |
The Credentials Setter for OAuth 2 Client Credentials Grant |
| customerHeaderCredentials | CustomerHeaderCredentials |
The Credentials Setter for Custom Header Signature |
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 | - |
| UAT | - |
Authorization
This API uses the following authentication schemes.
PublicBearerToken (OAuth 2 Bearer token)PublicBasicToken (Custom Header Signature)PrivateBasicToken (Custom Header Signature)client-authorization-token (OAuth 2 Client Credentials Grant)customerHeader (Custom Header Signature)
List of APIs
SDK Infrastructure
Configuration
- ProxyConfigurationBuilder
- LoggingConfigurationBuilder
- RequestLoggingConfigurationBuilder
- ResponseLoggingConfigurationBuilder
HTTP
Utilities
All versions of loyalty-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.17