Довідник API

BotLaunch API

Створюйте потужні інтеграції з REST API BotLaunch. Повний доступ до ботів, користувачів, повідомлень та іншого з вичерпною документацією та прикладами.

Базовий URL

https://api.botlaunch.io

Версія

v1.0

Авторизація

JWT Bearer

Швидкий старт

Почніть роботу з API BotLaunch за лічені хвилини.

1. Встановіть або протестуйте

# Install the BotLaunch SDK
npm install @botlaunch/sdk

# Or use the REST API directly
curl -X GET "https://api.botlaunch.io/api/health" \
  -H "Content-Type: application/json"

bash

2. Автентифікуйтесь

// Authenticate and get an access token
const response = await fetch("https://api.botlaunch.io/api/auth/login", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    email: "your@email.com",
    password: "your-password"
  })
});

const { data } = await response.json();
console.log(data.accessToken);

javascript

3. Робіть API-запити

// Make authenticated API calls
const bots = await fetch("https://api.botlaunch.io/api/bots", {
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "x-organization-id": "YOUR_ORG_ID"
  }
});

const { data } = await bots.json();
console.log(data); // Array of your bots

javascript

Ендпоінти API

Ознайомтеся з доступними ендпоінтами API, організованими за типом ресурсу.

Автентифікація

Дізнайтеся про JWT токени, API ключі та безпечні методи автентифікації.

Переглянути документацію

Боти

Створюйте, налаштовуйте та керуйте своїми Telegram ботами програмно.

Переглянути документацію

Користувачі

Керуйте користувачами, дозволами та учасниками організації.

Переглянути документацію

Повідомлення

Надсилайте повідомлення, обробляйте зворотні виклики та керуйте розмовами.

Переглянути документацію

Вебхуки

Налаштовуйте вебхуки для отримання подій та сповіщень у реальному часі.

Переглянути документацію

Формат відповіді

Усі відповіді API мають узгоджену JSON-структуру.

Успішна відповідь

{
  "data": {
    "id": "bot_123",
    "name": "My Bot",
    "status": "active"
  },
  "message": "Bot retrieved successfully"
}

json

Відповідь з помилкою

{
  "error": "Unauthorized",
  "statusCode": 401,
  "message": "Invalid or expired token"
}

json

Пагінована відповідь

{
  "data": [
    { "id": "bot_1", "name": "Bot 1" },
    { "id": "bot_2", "name": "Bot 2" }
  ],
  "total": 25,
  "page": 1,
  "limit": 10
}

json

Обмеження частоти запитів

API-запити обмежені для забезпечення справедливого використання та стабільності платформи.

План	Запитів/хв	Запитів/день	Ліміт сплеску
Free	60	1,000	10
Starter	300	10,000	50
Professional	1,000	50,000	100
Business	5,000	Unlimited	500
Enterprise	Custom	Unlimited	Custom

Заголовки обмеження частоти

Check X-RateLimit-Remaining and X-RateLimit-Reset headers in API responses to monitor your usage.

Назад до документації Автентифікація