sdksio.LoyaltySDK 0.0.3

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

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package sdksio.LoyaltySDK --version 0.0.3

You can also view the package at: https://www.nuget.org/packages/sdksio.LoyaltySDK/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:

The API client can be initialized as follows:

Code-Based Initialization

using LoyaltyApIs.Standard;
using LoyaltyApIs.Standard.Authentication;
using Microsoft.Extensions.Logging;

namespace ConsoleApp;

LoyaltyApIsClient client = new LoyaltyApIsClient.Builder()
    .PublicBearerTokenCredentials(
        new PublicBearerTokenModel.Builder(
            "AccessToken"
        )
        .Build())
    .PublicBasicTokenCredentials(
        new PublicBasicTokenModel.Builder(
            "Public Basic Token"
        )
        .Build())
    .PrivateBasicTokenCredentials(
        new PrivateBasicTokenModel.Builder(
            "Public Basic Token"
        )
        .Build())
    .ClientAuthorizationTokenCredentials(
        new ClientAuthorizationTokenModel.Builder(
            "OAuthClientId",
            "OAuthClientSecret"
        )
        .Build())
    .CustomerHeaderCredentials(
        new CustomerHeaderModel.Builder(
            "Authorization-Token"
        )
        .Build())
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .Environment(LoyaltyApIs.Standard.Environment.Sit)
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using LoyaltyApIs.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = LoyaltyApIsClient
    .FromConfiguration(configuration.GetSection("LoyaltyApIs"));

See the Configuration-Based Initialization section for details.

Environments

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

Fields

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

• Profile Management
• Authorization
• Offer
• Balances
• Redemption
• Transaction

SDK Infrastructure

Configuration

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter