Базова URL-адреса та версіонування

Базова URL-адреса production-середовища:

https://api.ltesocks.io/v2

Додайте до неї задокументований шлях. Наприклад, GET /ports перетворюється на:

GET https://api.ltesocks.io/v2/ports

Налаштування endpoint SDK

Офіційні SDK за замовчуванням використовують production URL. Перевизначайте її лише для приватного або тестового розгортання:

JavaScript

const client = LTESocksClient.withBearerToken(token, {
  baseUrl: 'https://api.example.test/v2',
  timeoutMs: 30_000,
});

Python

client = Client.with_bearer_token(
    token,
    base_url="https://api.example.test/v2",
    timeout=30.0,
)

PHP

<?php

$client = Client::builder()
    ->withBearerToken($token)
    ->withBaseUri('https://api.example.test/v2')
    ->withTimeout(30.0, 5.0)
    ->build();

Межі версії

Версія є частиною URL-адреси. Ця документація охоплює лише активний публічний контракт v2. Не вилучайте префікс /v2 і не замінюйте його незадокументованою версією.

У межах v2 сумісні доповнення можуть додавати необов’язкові поля відповіді або нові значення enum. Клієнтам слід:

• ігнорувати невідомі властивості JSON;
• не покладатися на вичерпний перелік значень enum;
• перевіряти поля, які вони фактично використовують;
• спиратися на HTTP-статус і задокументовані формати помилок;
• прив’язувати робочу поведінку до v2, а не до прикладів даних.

HTTPS

Використовуйте HTTPS для кожного запиту. Bearer-токен ніколи не можна передавати через незашифроване з’єднання. Застосовуйте звичайну перевірку сертифікатів і сучасний стек TLS.