@torbox/torbox-api v1.0.6

Table of Contents

• Setup \& Configuration
  • Supported Language Versions
  • Installation
  • Authentication
    • Access Token Authentication
      • Setting the Access Token
  • Setting a Custom Timeout
• Sample Usage
  • Documentation
  • Models

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: TypeScript >= 4.8.4

Installation

To get started with the SDK, we recommend installing using pnpm:

pnpm install @torbox/torbox-api

Authentication

Access Token Authentication

The TorboxApi API uses an Access Token for authentication.

This token must be provided to authenticate your requests to the API.

Setting the Access Token

When you initialize the SDK, you can set the access token as follows as well as a few more variables:

const sdk = new TorboxApi({ token: 'YOUR_TOKEN', baseUrl: 'https://api.torbox.app' });

If you need to set or update the access token after initializing the SDK, you can use:

const sdk = new TorboxApi();
sdk.token = 'YOUR_TOKEN';
sdk.baseUrl = 'https://api.torbox.app';

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

const torboxApi = new TorboxApi({ timeout: 10000 });

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

import { TorboxApi } from '@torbox/torbox-api';

(async () => {
  const torboxApi = new TorboxApi({
    token: 'YOUR_TOKEN',
    baseUrl: 'https://api.torbox.app';
  });

  const { data } = await torboxApi.general.getUpStatus();

  console.log(data);
})();

Documentation

The SDK provides various services to interact with the API.

Models

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.