Getting Started with splitit-web-api-v4

Introduction

Splitit Orchestration API for managing installment plans.

Install the Package

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

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.Sandbox | | timeout | number | Timeout for API calls.Default: 0 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | oAuth2Credentials | OAuth2Credentials | The credential object for oAuth2 | | apiKeyCredentials | ApiKeyCredentials | The credential object for apiKey |

The API client can be initialized as follows:

Code-Based Client Initialization

import {
  Client,
  Environment,
  OAuthScopeOAuth2Enum,
} from 'splitit-payments-sdk';

const client = new Client({
  oAuth2Credentials: {
    oAuthClientId: 'OAuthClientId',
    oAuthClientSecret: 'OAuthClientSecret',
    oAuthScopes: [
      OAuthScopeOAuth2Enum.ApiV4
    ]
  },
  apiKeyCredentials: {
    'X-Splitit-Api-Key': 'X-Splitit-Api-Key'
  },
  timeout: 0,
  environment: Environment.Sandbox,
});

Configuration-Based Client Initialization

import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'splitit-payments-sdk';

// Provide absolute path for the configuration file
const absolutePath = path.resolve('./config.json');

// Read the configuration file content
const fileContent = fs.readFileSync(absolutePath, 'utf-8');

// Initialize client from JSON configuration content
const client = Client.fromJsonConfig(fileContent);

See the Configuration-Based Client Initialization section for details.

Environment-Based Client Initialization

import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'splitit-payments-sdk';

// Optional - Provide absolute path for the .env file
const absolutePath = path.resolve('./.env');

if (fs.existsSync(absolutePath)) {
  // Load environment variables from .env file
  dotenv.config({ path: absolutePath, override: true });
}

// Initialize client using environment variables
const client = Client.fromEnvironment(process.env);

See the Environment-Based Client Initialization section for details.

Environments

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

Fields

| Name | Description | | --- | --- | | Sandbox | Default Sandbox Environment (Transactional API) | | Production | Production Environment (Transactional API) |

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

• HttpClientOptions
• RetryConfiguration
• ProxySettings
• Configuration-Based Client Initialization
• Environment-Based Client Initialization

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError