Fragment API

Документация

Описание API и полноценный тестер всех основных методов в одном месте.

Старт

Как начать

  1. Создайте аккаунт.
  2. Скопируйте fg_key_… в кабинете.
  3. Создайте frag_live_… Bearer-токен.
  4. Подключите Fragment account.
  5. Используйте методы Stars / Premium.
Читать документацию можно без регистрации. Для выполнения защищённых запросов в тестере нужны ваши credentials.
Авторизация

API key и Bearer token

API key

fg_key_… — создание, список и отзыв Bearer-токенов.

X-API-Key: fg_key_xxx
Bearer token

frag_live_… — рабочие запросы API.

Authorization: Bearer frag_live_xxx
POST/api/v1/tokens

Токены

curl -X POST "http://fragment-api-thc.xyz/api/v1/tokens" \
  -H "X-API-Key: fg_key_xxx" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production"}'
GET /api/v1/tokens

Получить список токенов.

DELETE /api/v1/tokens/{token_id}

Отозвать токен.

Accounts

Fragment accounts

POST/api/v1/accounts/auth

Начать подключение Fragment account.

GET/api/v1/accounts/auth/{job_id}

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

GET/api/v1/accounts

Список подключённых accounts.

GET/api/v1/accounts/{account_id}/prices

Получить цены Stars и Premium.

GET/api/v1/accounts/{account_id}/wallet

Получить информацию о wallet.

POST/api/v1/orders/stars

Купить Stars

curl -X POST "http://fragment-api-thc.xyz/api/v1/orders/stars" \
  -H "Authorization: Bearer frag_live_xxx" \
  -H "Idempotency-Key: order-stars-1001" \
  -H "Content-Type: application/json" \
  -d '{
    "account_id":"YOUR_ACCOUNT_UUID",
    "username":"@username",
    "amount":500,
    "payment_method":"ton",
    "show_sender":true
  }'
POST/api/v1/orders/premium

Купить Premium

{
  "account_id":"YOUR_ACCOUNT_UUID",
  "username":"@username",
  "months":3,
  "payment_method":"ton",
  "show_sender":true
}

Срок: 3, 6 или 12 месяцев.

GET/api/v1/orders/{order_id}

Статус заказа

Возвращает состояние заказа, результат выполнения и ошибку, если она возникла.

Ошибки

HTTP status и Request ID

Каждый ответ содержит X-Request-ID. Ошибки авторизованных запросов также появляются в кабинете.

400Неверный запрос
401Неверный ключ или токен
403Доступ запрещён
404Объект не найден
422Ошибка данных
429Слишком много запросов
Тест API

Проверка методов

Выберите любой основной метод API. Форма автоматически покажет только нужные поля.

Введённые credentials и seed используются браузером только для отправки выбранного запроса и не сохраняются в localStorage.

Request
POST /api/v1/orders/stars
— msRequest ID: —

      
Response
Ready
Заполните данные и нажмите Send API Request.