Splitit.InstallmentsSDK 2.0.11

Getting Started with splitit-web-api-v4

Introduction

Splitit Orchestration API for managing installment plans.

Install the Package

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

dotnet add package Splitit.InstallmentsSDK --version 2.0.11

You can also view the package at: https://www.nuget.org/packages/Splitit.InstallmentsSDK/2.0.11

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 SplititWebApiV4.Standard;
using SplititWebApiV4.Standard.Authentication;
using SplititWebApiV4.Standard.Models;
using System.Collections.Generic;

namespace ConsoleApp;

SplititWebApiV4Client client = new SplititWebApiV4Client.Builder()
    .OAuth2Credentials(
        new OAuth2Model.Builder(
            "OAuthClientId",
            "OAuthClientSecret"
        )
        .OAuthScopes(
            new List<OAuthScopeOAuth2Enum>
            {
                OAuthScopeOAuth2Enum.ApiV4,
            })
        .Build())
    .ApiKeyCredentials(
        new ApiKeyModel.Builder(
            "X-Splitit-Api-Key"
        )
        .Build())
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .Environment(SplititWebApiV4.Standard.Environment.Sandbox)
    .Build();

Configuration-Based Initialization

using SplititWebApiV4.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 = SplititWebApiV4Client
    .FromConfiguration(configuration.GetSection("SplititWebApiV4"));

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.

• OAuth2 (OAuth 2 Client Credentials Grant)
• ApiKey (Custom Header Signature)

List of APIs

• Installment Plan

SDK Infrastructure

Configuration

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter