Перейти до основного контенту

Витрата трафіку residential

Дізнайтеся, скільки трафіку витратив residential-пакет і скільки це коштувало, через API.

У цьому посібнику показано, як дізнатися, скільки трафіку витратив residential-пакет і скільки це коштувало.

Кожен запит використовує ваш персональний API-ключ з особистого кабінету (як отримати API-ключ). У прикладах нижче замініть YOUR_API_KEY на свій ключ. Щоб сплатити з балансу акаунта, використовуйте paymentId = 1.

Крок 1 — Отримайте інформацію про пакет

Отримайте статус пакета та залишок трафіку. Скопіюйте package_key.

Ендпоінт

GET https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/package

Відповідь

{
  "status": "success",
  "data": {
    "rotation": 60,
    "traffic_limit": "7516192768",
    "traffic_usage": "10",
    "traffic_left": "10",
    "package_key": "1234567890abcdefedcb",
    "expired_at": "d.m.Y",
    "is_active": true,
    "tarif_id": 2
  },
  "errors": []
}

Крок 2 — Отримайте витрату трафіку

Отримайте детальну витрату трафіку по пакету. Можна відфільтрувати за логіном листа або діапазоном дат.

Ендпоінт

POST https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/traffic/details

Тіло запиту

Назва

Тип

Опис

packageKey

String

Ключ пакета (з інформації про пакет).

login (необов'язковий)

String

Необов'язково: фільтр за логіном листа.

date_start (необов'язковий)

String

Необов'язковий фільтр за датою, формат DD.MM.YYYY.

date_end (необов'язковий)

String

Необов'язковий фільтр за датою, формат DD.MM.YYYY.

Відповідь

{
  "status": "success",
  "data": {
    "package_key": "1234567890abcdefedcb",
    "traffic_usage": "275414777856",
    "traffic_usage_formated": "256.5 GB"
  },
  "errors": []
}

Крок 3 — Отримайте звіт про витрати

Отримайте звіт про витрати: сума, ціна за ГБ і розбивка за листами.

Ендпоінт

POST https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/consumption

Тіло запиту

Назва

Тип

Опис

login (необов'язковий)

String

Необов'язково: фільтр за логіном листа.

date_start (необов'язковий)

String

Необов'язковий фільтр за датою, формат DD.MM.YYYY.

date_end (необов'язковий)

String

Необов'язковий фільтр за датою, формат DD.MM.YYYY.

Відповідь

{
  "status": "success",
  "data": {
    "package_key": "1234567890abcdefedcb",
    "orders_amount": "$557.99",
    "orders_bytes_formated": "256.5 GB",
    "price_per_gb": "$2.17"
  },
  "errors": []
}

Повна документація API

Ви отримали відповідь на своє запитання?