Skip to content

SDK

Для удобной интеграции с API доступны официальные SDK на трёх языках.

TypeScript / JavaScript

npm

Полнофункциональный клиент с поддержкой TypeScript, автодополнением и типизацией всех ответов.

Установка:

bash
npm install @tgio-analytics/sdk

Быстрый старт:

ts
import { TgioClient } from '@tgio-analytics/sdk';

const client = new TgioClient({
  token: 'tgio_sk_ваш_токен',
});

// Создать короткую ссылку
const link = await client.links.create({
  url: 'https://example.com/product/123',
  title: 'Продвижение товара',
  utm_source: 'telegram',
});

console.log(link.trackingUrl); // https://tgio.app/abc123

// Статистика
const stats = await client.links.getStats(link.id, '30d');
console.log(`Клики: ${stats.totalClicks}, Уникальные: ${stats.uniqueClicks}`);

Совместимость: Node.js ≥ 18, все современные браузеры, Bun, Deno.

PHP

SDK для PHP 7.4+ без внешних зависимостей (только ext-curl и ext-json). PSR-4 автозагрузка, подробные PHPDoc-комментарии.

Установка:

bash
composer require tgio/sdk

Быстрый старт:

php
use Tgio\Sdk\TgioClient;

$client = new TgioClient('tgio_sk_ваш_токен');

// Создать ссылку
$link = $client->links->create(['url' => 'https://example.com']);
echo $link['trackingUrl'];

// Получить статистику
$stats = $client->links->getStats($link['id'], '30d');
echo "Клики: {$stats['totalClicks']}";

Python

SDK для Python 3.8+ на базе httpx.

Установка:

bash
pip install tgio-sdk

Быстрый старт:

python
from tgio_sdk import TgioClient

client = TgioClient(token="tgio_sk_ваш_токен")

# Создать ссылку
link = client.links.create(url="https://example.com", title="Моя ссылка")
print(link["trackingUrl"])

# Статистика
stats = client.links.get_stats(link["id"], period="30d")
print(f"Клики: {stats['totalClicks']}")

Доступные модули

Все SDK имеют одинаковый набор модулей:

МодульОписание
authАутентификация через Telegram
linksСоздание, редактирование ссылок + аналитика
pixelsПиксели отслеживания + аналитика
channelsTelegram-каналы, подписчики, посты, бенчмарки
tagsОрганизация ссылок и пикселей по тегам
tokensУправление API-токенами
accountПодписка, тарифы, настройки
domainsКастомные домены для коротких ссылок
trackingМониторинг ключевых слов в Telegram
secureЗащищённый обмен файлами
catalogКаталог публичных каналов

Обработка ошибок

Все SDK выбрасывают типизированное исключение при HTTP-ошибках:

ts
import { TgioApiError } from '@tgio-analytics/sdk';

try {
  await client.links.create({ url: 'invalid' });
} catch (err) {
  if (err instanceof TgioApiError) {
    console.error(`HTTP ${err.status}: ${err.message}`);
  }
}
php
try {
    $client->links->create(['url' => 'invalid']);
} catch (\Tgio\Sdk\TgioApiError $e) {
    echo "HTTP {$e->getStatus()}: {$e->getMessage()}";
}
python
from tgio_sdk import TgioApiError

try:
    client.links.create(url="invalid")
except TgioApiError as e:
    print(f"HTTP {e.status}: {e.message}")

Получение API-токена

  1. Откройте @tgio_app_bot или веб-дашборд
  2. Перейдите в Настройки → API-токены
  3. Создайте токен с нужными правами доступа (scope)
  4. Используйте токен в формате tgio_sk_...

Подробнее: API-токены, Аутентификация.

Telegram-аналитика для тех, кто понимает