test-sdk-apimatic-sdk v1.1.1

Getting Started with CELITECH API

Introduction

Welcome to the CELITECH API documentation!

Useful links: Homepage | Support email | Blog

Introduction

This guide is your go-to resource for the CELITECH API, with full documentation and schemas.

Need help? Email us at support@celitech.com.

"Partners" refers to online service providers that use our eSIM API. Access levels include Gold, Platinum, and Diamond.

API

The CELITECH API is designed for use by partner platforms, including both web and mobile applications. It's assumed all endpoint calls are initiated from the backend of an integrated platform.

API URL: https://api.celitech.net/v1

Authentication & Authorization

CELITECH API uses the OAuth 2.0 protocol for authentication and authorization. The endpoints are protected using client credentials flow which is based on a token exchange. The token has a defined life span (typically 1 hour), after which a new token must be obtained.

To begin, obtain OAuth 2.0 client credentials ( CLIENT_ID & CLIENT_SECRET ) from the CELITECH Dashboard. Then your client application requests an access token from the CELITECH Authorization Server, extracts a token from the response, and sends the token to the CELITECH API that you want to access.

Security Scheme Type: OAuth2

Flow type: clientCredentials

Token URL: https://auth.celitech.net/oauth2/token

Install the Package

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

npm install test-sdk-apimatic-sdk@1.1.1

For additional package details, see the Npm page for the test-sdk-apimatic-sdk@1.1.1 npm.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

HttpClientOptions

RetryConfiguration

The API client can be initialized as follows:

const client = new Client({
  timeout: 0,
  environment: Environment.Production,
  oAuthClientId: 'OAuthClientId',
  oAuthClientSecret: 'OAuthClientSecret',
});

Authorization

This API uses OAuth 2 Client Credentials Grant.

Client Credentials Grant

Your application must obtain user authorization before it can execute an endpoint call in case this SDK chooses to use OAuth 2.0 Client Credentials Grant. This authorization includes the following steps

The fetchToken method will exchange the OAuth client credentials for an access token. The access token is an object containing information for authorizing client requests and refreshing the token itself.

try {
  const token = await client.clientCredentialsAuthManager.fetchToken();
  client.withConfiguration({
    oAuthToken: token,
  });
} catch(error) {
  // handle ApiError or OAuthProviderError if needed
}

The client can now make authorized endpoint calls.

Storing an access token for reuse

It is recommended that you store the access token for reuse.

Store the token in session storage or local storage.

Creating a client from a stored token

To authorize a client from a stored access token, just set the access token in Configuration along with the other configuration parameters before creating the client:

const newClient = client.withConfiguration({oAuthToken: token});

Complete example

// function for storing token to database
async function saveTokenToDatabase(token: OAuthToken) {
  // Code to save the token to the database
}

// function for loading token from database
async function loadTokenFromDatabase(): Promise<OAuthToken | undefined> {
  // Load token from the database and return it (return undefined if no token exists)
  return undefined;
}

// create a new client
const client = new Client({
  timeout: 0,
  environment: Environment.Production,
  oAuthClientId: 'OAuthClientId',
  oAuthClientSecret: 'OAuthClientSecret',
});

// obtain access token, needed for client to be authorized
const previousToken = await loadTokenFromDatabase();
if (previousToken) {
  // restore previous access token and update the cloned configuration with the token
  return client.withConfiguration({
   oAuthToken: previousToken,
  });
} else {
  // obtain a new access token
  try {
    const token = await client.clientCredentialsAuthManager.fetchToken();
    await saveTokenToDatabase(token);
    return client.withConfiguration({
     oAuthToken: token,
    });
  } catch (error) {
      if (error instanceof OAuthProviderError) {
          // handle OAuthProviderError if needed
      }
      return client;
    }
}

List of APIs

• O Auth Authorization
• Destinations
• E SIM
• Packages
• Purchases

Classes Documentation

• ApiResponse
• ApiError