Перейти до вмісту

Офіційні SDK

Офіційні SDK надають ті самі автентифіковані операції API v2 як типізовані методи ресурсів. Використовуйте їх у довірених серверних застосунках і ніколи не передавайте API-токен облікового запису до браузерного коду.

SDKСередовище виконанняПакетВихідний код
JavaScript / TypeScriptNode.js 22 або новіше@ltesocks/sdkGitHub
PythonPython 3.11 або новішеltesocks-sdkGitHub
PHPPHP 8.3 або новішеltesocks/php-sdkGitHub

Виберіть мову. Вибір зберігатиметься для всіх прикладів SDK на цьому сайті.

Terminal window
# npm
npm install @ltesocks/sdk
# pnpm
pnpm add @ltesocks/sdk
# Yarn
yarn add @ltesocks/sdk

Задайте LTESOCKS_API_TOKEN у змінній середовища процесу, а потім створіть клієнт. Базова production URL-адреса та заголовок авторизації налаштовуються автоматично.

import { LTESocksClient } from '@ltesocks/sdk';
const client = LTESocksClient.withBearerToken(
process.env.LTESOCKS_API_TOKEN,
{ language: 'en' },
);

Синхронний і асинхронний Python

Section titled “Синхронний і асинхронний Python”

Для стислості приклади в документації використовують синхронний Client. У застосунках з асинхронним циклом подій використовуйте AsyncClient з тими самими назвами ресурсів та очікуйте кожну операцію:

import os
from ltesocks_sdk import AsyncClient
async with AsyncClient.with_bearer_token(
os.environ["LTESOCKS_API_TOKEN"],
language="en",
) as client:
user = await client.user.get()
print(user.login)
  • Кожен SDK за замовчуванням звертається до https://api.ltesocks.io/v2 і надсилає Accept-Language.
  • Типізовані ресурси охоплюють користувача, порти, платежі, тарифи, сервери та сигнатури.
  • Підтримувані мутації автоматично отримують ключ ідемпотентності. Транспортний збій без HTTP-відповіді можна повторити з тим самим ключем; відповіді з HTTP-помилкою автоматично не повторюються.
  • Класи помилок зберігають статус, деталі відповіді, час дозволеного повтору, заголовки та ключ ідемпотентності запиту, якщо він доступний.
  • Метод сирого запиту дає змогу тимчасово викликати новий endpoint до регенерації SDK.

Фіксуйте версію SDK у production і перевіряйте changelog перед оновленням. Контракт OpenAPI залишається джерелом істини щодо endpoint і моделей.

Продовжте зі швидкого старту або першого запиту.