Получение списков партнерских обменов

Доступные методы API

Базовый URL:

https://your-domain.com

Каждая точка доступа выглядит следующим образом:

https://your-domain.com/api/v1/{endpoint}

• Все эндпоинты возвращают время в формате Unix-time.

• и соответствуют стандарту JSON:API.

Список доступных методов

• Получение списка партнерских обменов (реферальных обменов):

Метод: «Получить список партнерских обменов»

Описание:

Возвращает перечень реферальных обменов, связанных с вашей партнерской учетной записью.

Используемый метод:

GET /api/v1/partner/referral-exchanges

Заголовки

Name	Value
X-API-Key	<ваш_api_ключ>

Ответ

Ответ

200

{
  "data": [
    {
      "type": "referral_exchange",
      "id": 1611085,
      "attributes": {
        "is_completed": true,
        "completed_at": 1691234567,
        "created_at": 1691230000,
        "exchange_currency_in": "USDTTRC20",
        "exchange_currency_out": "BTC",
        "exchange_amount": "0.05000000",
        "referral_reward": "12.50000000",
        "referral_reward_base_currency": "USDT",
        "transition_query_params": {
          "utm_source": "telegram",
          "utm_medium": "referral",
          "utm_campaign": "crypto_exchange_promo",
          "utm_content": "banner_usdt_to_btc",
          "utm_term": "usdt_btc_swap",
          "pid": "1101231"
        }
      }
    }
  ],
  "links": {
    "next_page": "https://your-domain.com/api/v1/partner/referral-exchanges?page=2",
    "previous_page": null
  },
  "counts": {
    "total": 2,
    "last_page": 2
  }
}

401

422

Пояснение полей:

• is_completed: завершился ли обмен (boolean)

• completed_at: время завершения (Unix timestamp)

• created_at: время создания (Unix timestamp)

• exchange_currency_in: валюта, которую отдает клиент

• exchange_currency_out: валюта, которую получает клиент

• exchange_amount: сумма обмена

• referral_reward: реферальное вознаграждение

• referral_reward_base_currency: валюта реферального вознаграждения

• transition_query_params: содержит параметры запроса, которые передаются, когда пользователь переходит по вашей реферальной ссылке. В реферальную ссылку можно добавить собственные параметры (например, UTM-метки) - они сохраняются в этом поле. Это позволяет отслеживать источник, кампанию, тип трафика и другие маркетинговые параметры перехода.

  • Пример:

    • Базовая реферальная ссылка:

      https://example.com?rid=123

    • С дополнительными UTM-метками:

      https://example.com?rid=123&utm_source=telegram&utm_medium=referral&utm_campaign=crypto_promo