PHPackages                             shell/loyalty-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. shell/loyalty-sdk

ActiveLibrary[CLI & Console](/categories/cli)

shell/loyalty-sdk
=================

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.

0.0.3(1mo ago)03MITPHP ^7.2 || ^8.0

Since Jul 6Compare

[ Source](https://github.com/sdks-io/loyalty-php-sdk)[ Packagist](https://packagist.org/packages/shell/loyalty-sdk)[ Docs](https://developer.shell.com/)[ RSS](/packages/shell-loyalty-sdk/feed)WikiDiscussions Synced 1w ago

READMEChangelogDependencies (5)Versions (4)Used By (0)

Getting Started with Loyalty APIs
=================================

[](#getting-started-with-loyalty-apis)

Introduction
------------

[](#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
-------------------

[](#install-the-package)

Run the following command to install the package and automatically add the dependency to your composer.json file:

```
composer require "shell/loyalty-sdk:0.0.3"
```

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

```
"require": {
    "shell/loyalty-sdk": "0.0.3"
}
```

You can also view the package at:

Initialize the API Client
-------------------------

[](#initialize-the-api-client)

***Note:*** Documentation for the client can be found [here.](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/client.md)

The following parameters are configurable for the API Client:

ParameterTypeDescriptionenvironment[`Environment`](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/README.md#environments)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`](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/logging-configuration-builder.md)Represents the logging configurations for API callsproxyConfiguration[`ProxyConfigurationBuilder`](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/proxy-configuration-builder.md)Represents the proxy configurations for API callspublicBearerTokenCredentials[`PublicBearerTokenCredentials`](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/auth/oauth-2-bearer-token.md)The Credentials Setter for OAuth 2 Bearer tokenpublicBasicTokenCredentials[`PublicBasicTokenCredentials`](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/auth/custom-header-signature.md)The Credentials Setter for Custom Header SignatureprivateBasicTokenCredentials[`PrivateBasicTokenCredentials`](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/auth/custom-header-signature-1.md)The Credentials Setter for Custom Header SignatureclientAuthorizationTokenCredentials[`ClientAuthorizationTokenCredentials`](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/auth/oauth-2-client-credentials-grant.md)The Credentials Setter for OAuth 2 Client Credentials GrantcustomerHeaderCredentials[`CustomerHeaderCredentials`](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/auth/custom-header-signature-2.md)The Credentials Setter for Custom Header SignatureThe API client can be initialized as follows:

```
use LoyaltyApIsLib\Logging\LoggingConfigurationBuilder;
use LoyaltyApIsLib\Logging\RequestLoggingConfigurationBuilder;
use LoyaltyApIsLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use LoyaltyApIsLib\Environment;
use LoyaltyApIsLib\Authentication\PublicBearerTokenCredentialsBuilder;
use LoyaltyApIsLib\Authentication\PublicBasicTokenCredentialsBuilder;
use LoyaltyApIsLib\Authentication\PrivateBasicTokenCredentialsBuilder;
use LoyaltyApIsLib\Authentication\ClientAuthorizationTokenCredentialsBuilder;
use LoyaltyApIsLib\Authentication\CustomerHeaderCredentialsBuilder;
use LoyaltyApIsLib\LoyaltyApIsClientBuilder;

$client = LoyaltyApIsClientBuilder::init()
    ->publicBearerTokenCredentials(
        PublicBearerTokenCredentialsBuilder::init(
            'AccessToken'
        )
    )
    ->publicBasicTokenCredentials(
        PublicBasicTokenCredentialsBuilder::init(
            'Public Basic Token'
        )
    )
    ->privateBasicTokenCredentials(
        PrivateBasicTokenCredentialsBuilder::init(
            'Public Basic Token'
        )
    )
    ->clientAuthorizationTokenCredentials(
        ClientAuthorizationTokenCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
    )
    ->customerHeaderCredentials(
        CustomerHeaderCredentialsBuilder::init(
            'Authorization-Token'
        )
    )
    ->environment(Environment::SIT)
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();
```

Environments
------------

[](#environments)

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

### Fields

[](#fields)

NameDescriptionSIT**Default**PRODUCTION-UAT-Authorization
-------------

[](#authorization)

This API uses the following authentication schemes.

- [`PublicBearerToken (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/auth/oauth-2-bearer-token.md)
- [`PublicBasicToken (Custom Header Signature)`](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/auth/custom-header-signature.md)
- [`PrivateBasicToken (Custom Header Signature)`](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/auth/custom-header-signature-1.md)
- [`client-authorization-token (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/auth/oauth-2-client-credentials-grant.md)
- [`customerHeader (Custom Header Signature)`](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/auth/custom-header-signature-2.md)

List of APIs
------------

[](#list-of-apis)

- [Profile Management](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/controllers/profile-management.md)
- [Authorization](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/controllers/authorization.md)
- [Offer](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/controllers/offer.md)
- [Balances](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/controllers/balances.md)
- [Redemption](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/controllers/redemption.md)
- [Transaction](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/controllers/transaction.md)

SDK Infrastructure
------------------

[](#sdk-infrastructure)

### Configuration

[](#configuration)

- [ProxyConfigurationBuilder](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/proxy-configuration-builder.md)
- [LoggingConfigurationBuilder](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/logging-configuration-builder.md)
- [RequestLoggingConfigurationBuilder](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/request-logging-configuration-builder.md)
- [ResponseLoggingConfigurationBuilder](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/response-logging-configuration-builder.md)

### HTTP

[](#http)

- [HttpRequest](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/http-request.md)

### Utilities

[](#utilities)

- [ApiResponse](https://www.github.com/sdks-io/loyalty-php-sdk/tree/0.0.3/doc/api-response.md)

###  Health Score

33

—

LowBetter than 72% of packages

Maintenance90

Actively maintained with recent releases

Popularity3

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity31

Early-stage or recently created project

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

3

Last Release

48d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/ef06f97b4ff5db714f2a124525216538f97338487cd4e2bca22baa32c0bf90cd?d=identicon)[developer-sdksio](/maintainers/developer-sdksio)

---

Tags

shellapimaticsdksioloyaltySDKs

###  Code Quality

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/shell-loyalty-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/shell-loyalty-sdk/health.svg)](https://phpackages.com/packages/shell-loyalty-sdk)
```

###  Alternatives

[square/square

Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.

784.1M31](/packages/square-square)[paypal/paypal-server-sdk

PayPal's SDK for interacting with the REST APIs

61964.3k20](/packages/paypal-paypal-server-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)