Использование

С помощью flyerapi вы можете использовать FlyerAPI вместе с Telegram Документация: https://api.flyerservice.io/redoc

Установка

npm install flyerapi

или с использованием yarn:

yarn add flyerapi

Требования

• Node.js 18+
• TypeScript 5.0+ (опционально, для TypeScript проектов)

Возможности

• Asynchronous
• TypeScript support
• Exception handling
• Caching

Пример обязательной подписки с использованием grammY

import { Flyer } from 'flyerapi';

const flyer = new Flyer(KEY);

async function messageHandler(ctx: Context) {
    // Применяйте везде, где требуется проверка
    if (!await flyer.check(ctx.from.id, ctx.from.language_code)) {
        return;
    }
    // Ваш код
}

async function callbackHandler(ctx: Context) {
    // Применяйте везде, где требуется проверка
    if (!await flyer.check(ctx.from.id, ctx.from.language_code)) {
        return;
    }
    // Ваш код
}

Использование пользовательского сообщения

const message = {
    rows: 2,
    text: '<b>Пользовательский текст</b> для $name',  // HTML
    button_bot: 'Запустить',
    button_channel: 'Подписаться',
    button_url: 'Перейти',
    button_boost: 'Голосовать',
    button_fp: 'Выполнить',
};

await flyer.check(userId, languageCode, message);

Пример для заданий

// Получение заданий для пользователя
const tasks = await flyer.getTasks(userId, languageCode, 5);

// Получение статуса задания
const signature = tasks[0].signature;  // пример
const status = await flyer.checkTask(userId, signature);

Получение информации о боте

const botInfo = await flyer.getMe();

Получение завершенных заданий

const completedTasks = await flyer.getCompletedTasks(userId);

API

Constructor

new Flyer(key: string, debug?: boolean, requestOptions?: RequestOptions)

• key - API ключ (обязательный)
• debug - Включить режим отладки (опционально, по умолчанию false)
• requestOptions - Дополнительные опции для HTTP запросов (опционально)

Methods

check(userId, languageCode?, message?)

Проверяет статус подписки пользователя.

getTasks(userId, languageCode?, limit?)

Получает задания для пользователя.

checkTask(userId, signature)

Проверяет статус выполнения задания.

getCompletedTasks(userId)

Получает завершенные задания пользователя.

getMe()

Получает информацию о боте.

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

import { Flyer, APIError } from 'flyerapi';

try {
    await flyer.check(userId);
} catch (error) {
    if (error instanceof APIError) {
        console.error('API Error:', error.message);
    }
}

Developed by faustyu and cursor(bruh) (c) 2025