Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
- API version:
1.3.42 - SDK version:
1.3.42
Welcome to the CELITECH API documentation!
Useful links: Homepage | Support email | Blog
This SDK is compatible with the following versions: TypeScript >= 4.8.4
To get started with the SDK, we recommend installing using npm:
npm install celitech-sdkThe Celitech API uses OAuth for authentication.
You need to provide the OAuth parameters when initializing the SDK.
const sdk = new Celitech({ clientId: 'CLIENT_ID', clientSecret: 'CLIENT_SECRET' });If you need to set or update the OAuth parameters after the SDK initialization, you can use:
const sdk = new Celitech();
sdk.clientId = 'CLIENT_ID';
sdk.clientSecret = 'CLIENT_SECRET';These are the environment variables for the SDK:
| Name | Description |
|---|---|
| CLIENT_ID | Client ID parameter |
| CLIENT_SECRET | Client Secret parameter |
Environment variables are a way to configure your application outside the code. You can set these environment variables on the command line or use your project's existing tooling for managing environment variables.
If you are using a .env file, a template with the variable names is provided in the .env.example file located in the same directory as this README.
You can set a custom timeout for the SDK's HTTP requests as follows:
const celitech = new Celitech({ timeout: 10000 });Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
import { Celitech } from 'celitech-sdk';
(async () => {
const celitech = new Celitech({
clientId: 'CLIENT_ID',
clientSecret: 'CLIENT_SECRET',
});
const { data } = await celitech.destinations.listDestinations();
console.log(data);
})();The SDK provides various services to interact with the API.
Below is a list of all available services with links to their detailed documentation:
| Name |
|---|
| OAuthService |
| DestinationsService |
| PackagesService |
| PurchasesService |
| ESimService |
| IFrameService |
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
Below is a list of all available models with links to their detailed documentation:
This SDK is licensed under the MIT License.
See the LICENSE file for more details.