API пользователя
Содержание
- Отправка запроса
- Отключение методов
- Обработка ответа
- Использование пагинации
- Получение информации об аккаунте
- Получение истории обменов
- Получение истории реферальных обменов
- Получение истории инвестиций
- Покупка инвестиционных пакетов
- Получение сохраненных платежных реквизитов
- Добавление платежных реквизитов
- Удаление платежных реквизитов
Отправка запроса
API пользователя предоставляет возможность доступа к различным данным аккаунта конкретного для пользователя. Для работы с API необходима аутентификация с использованием секретного ключа выпущенного в профиле пользователя. Секретный ключ необходимо отправлять в HTTP заголовке "X-Authorization". Работа с API подразумевает отправку POST запроса на URL адрес нужного метода.
Отключение методов
Вы можете полностью закрыть доступ или отключить некоторые методы API пользователя в разделе "Настройки приложения" — "Настройка API пользователя".
Обработка ответа
Пример успешного ответа:
{
"success": true,
"result": [
"data"
]
}
Пример неуспешного ответа:
{
"success": false,
"message": "Текст ошибки",
"result": false
}
Использование пагинации
Для пагинации списков используйте параметр "page" с номером позиции в качестве значения.
Пример ответа с использованием пагинации:
{
"success": true,
"pagination": [
200,
50
],
"result": [
"data"
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Общее количество элементов |
| 1 | Количество элементов для текущей позиции |
Получение информации об аккаунте
Метод:
/user-api-get-info
Пример запроса:
curl -X POST 'https://demo.exchanger-cms.com/user-api-get-info' \
--header 'X-Authorization: 66b718871e40a56b15b828500fdb9dbf'
Пример ответа:
{
"success": true,
"result": [
1,
0,
null,
1575528540,
"demo",
"[email protected]",
"14386.74 USD",
"0.0200 %",
"0.4000 %",
"1000.00 USD",
"10303.67 USD",
"34021.00 USD",
14386.74,
0.02,
0.4,
1000,
10303.67,
34021,
"05.12.2019, 09:49",
1,
"138.68.153.210",
"GB",
"https://demo.exchanger-cms.com/?ref=demo"
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Активен (да - 1, нет - 0) |
| 1 | Верифицирован (да - 1, нет - 0) |
| 2 | Логин реферера (если нет - null) |
| 3 | Дата регистрации в формате Unix Timestamp |
| 4 | Логин |
| 5 | Электронная почта |
| 6 | Баланс, включая код валюты |
| 7 | Бонус на обмен, включая символ процентов |
| 8 | Ставка по реферальной программе, включая символ процента |
| 9 | Оборот заявок на обмен, включая код валюты |
| 10 | Оборот по реферальной программе, включая код валюты |
| 11 | Оборот по инвестиционной программе, включая код валюты |
| 12 | Баланс |
| 13 | Бонус на обмен |
| 14 | Ставка по реферальной программе |
| 15 | Оборот заявок на обмен |
| 16 | Оборот по реферальной программе |
| 17 | Оборот по инвестиционной программе |
| 18 | Дата регистрации в форматированном виде |
| 19 | Идентификатор |
| 20 | IP адрес |
| 21 | Двухбуквенный код страны |
| 22 | Реферальная ссылка |
Получение истории обменов
Метод:
/user-api-get-orders
Пример запроса:
curl -X POST 'https://demo.exchanger-cms.com/user-api-get-orders' \
--header 'X-Authorization: 66b718871e40a56b15b828500fdb9dbf'
Пример ответа:
{
"success": true,
"pagination": [
1,
1
],
"result": [
[
"66d2c80b698c4815898161d40b451940",
0,
"usdt-eth",
19,
52,
"USDT",
"ETH",
"USDT",
"ETH",
547.20336449,
1,
100,
0.18278396,
8,
8,
3.655e-5,
0,
1606031927,
null
]
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Токен |
| 1 | Идентификатор статуса заявки на обмен |
| 2 | Строка идентификатор направления обмена |
| 3 | Идентификатор отдаваемой валюты |
| 4 | Идентификатор получаемой валюты |
| 5 | Строка идентификатор отдаваемой валюты |
| 6 | Строка идентификатор получаемой валюты |
| 7 | Код отдаваемой валюты |
| 8 | Код получаемой валюты |
| 9 | Курс отдаваемой валюты |
| 10 | Курс получаемой валюты |
| 11 | Отдаваемая сумма |
| 12 | Получаемая сумма |
| 13 | Количество знаков после запятой у отдаваемой валюты |
| 14 | Количество знаков после запятой у получаемой валюты |
| 15 | Сумма бонуса |
| 16 | Сумма реферального вознаграждения |
| 17 | Дата создания в формате Unix Timestamp |
| 18 | Логин реферера (если нет - null) |
Идентификаторы статуса заявки на обмен:
| # | Описание |
|---|---|
| 0 | Ожидает оплаты |
| 1 | Оплачена |
| 2 | Приостановлена |
| 3 | Отменена |
| 4 | Выполнена |
Получение истории реферальных обменов
Метод:
/user-api-get-referral-orders
Пример запроса:
curl -X POST 'https://demo.exchanger-cms.com/user-api-get-referral-orders' \
--header 'X-Authorization: 66b718871e40a56b15b828500fdb9dbf'
Пример ответа:
{
"success": true,
"pagination": [
1,
1
],
"result": [
[
"a54b623b73*****",
4,
"eth-monobuah",
52,
26,
"ETH",
"MONOBUAH",
"ETH",
"UAH",
1,
16486.42087396,
1,
16488.07,
8,
2,
1.65,
0.91,
1593069902,
"brian_demuro_e8d2bd9"
]
]
}
Обработка ответа:
Индексы массива полностью соответствуют методу "/user-api-get-orders", за исключением что вместо логина реферера отображается логин реферала, а токен заявки на обмен скрыт и содержит только десять первых символов.
Получение истории инвестиций
Метод:
/user-api-get-investments
Пример запроса:
curl -X POST 'https://demo.exchanger-cms.com/user-api-get-investments' \
--header 'X-Authorization: 66b718871e40a56b15b828500fdb9dbf'
Пример ответа:
{
"success": true,
"pagination": [
1,
1
],
"result": [
[
"d2d33d4bac68ed80aa9fac7148d39746",
1,
"1000.00 USD",
"0.00 USD",
"21.00 %",
180,
1642486555,
1645078555,
1658038555,
"18.01.2022, 09:15",
"17.02.2022, 09:15",
"17.07.2022, 09:15",
1000,
0,
21
]
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Токен |
| 1 | Активна (да - 1, нет - 0) |
| 2 | Сумма инвестирования, включая код валюты |
| 3 | Начисленная сумма, включая код валюты |
| 4 | Процентная ставка по вкладу, включая символ процентов |
| 5 | Период инвестирования в днях |
| 6 | Дата создания в формате Unix Timestamp |
| 7 | Дата последнего начисления в формате Unix Timestamp |
| 8 | Дата окончания в формате Unix Timestamp |
| 9 | Дата создания в форматированном виде |
| 10 | Дата последнего начисления в форматированном виде |
| 11 | Дата окончания в форматированном виде |
| 12 | Сумма инвестирования |
| 13 | Начисленная сумма |
| 14 | Процентная ставка по вкладу |
Покупка инвестиционных пакетов
Метод:
/user-api-create-investments
Пример запроса:
curl -X POST 'https://demo.exchanger-cms.com/user-api-create-investments' \
--header 'X-Authorization: 66b718871e40a56b15b828500fdb9dbf'\
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'tariff=2' \
--data-urlencode 'amount=100'
Параметры запроса:
| Параметр | Описание |
|---|---|
| tariff | Идентификатор инвестиционного пакета |
| amount | Сумма инвестиции |
Список идентификаторов инвестиционных пакетов можно получить используя метод публичного API "/public-api-get-investment-program".
Пример ответа:
{
"success": true,
"result": [
"1c6075daad700d510c2ed508dff9da6a"
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Токен |
Получение сохраненных платежных реквизитов
Метод:
/user-api-get-details
Пример запроса:
curl -X POST 'https://demo.exchanger-cms.com/user-api-get-details' \
--header 'X-Authorization: 66b718871e40a56b15b828500fdb9dbf'
Пример ответа:
{
"success": true,
"pagination": [
1,
1
],
"result": [
[
19,
"USDT",
"0xf7bba751697018315f664eb8286fd0897b634404"
]
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Идентификатор валюты |
| 1 | Строка идентификатор валюты |
| 2 | Платежные реквизиты |
Добавление платежных реквизитов
Метод:
/user-api-create-details
Пример запроса:
curl -X POST 'https://demo.exchanger-cms.com/user-api-create-details' \
--header 'X-Authorization: 66b718871e40a56b15b828500fdb9dbf'\
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'currency=ETH' \
--data-urlencode 'value=0x1b4fBfb1FD99d00128afEB4Dc25Fc1D6608b1134'
Параметры запроса:
| Параметр | Описание |
|---|---|
| currency | Строка идентификатор валюты |
| value | Платежные реквизиты |
Список строк идентификаторов валют можно получить используя метод публичного API "/public-api-get-currencies".
Пример ответа:
{
"success": true,
"result": true
}
Удаление платежных реквизитов
Метод:
/user-api-delete-details
Пример запроса:
curl -X POST 'https://demo.exchanger-cms.com/user-api-delete-details' \
--header 'X-Authorization: 66b718871e40a56b15b828500fdb9dbf'\
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'currency=ETH'
Параметры запроса:
| Параметр | Описание |
|---|---|
| currency | Строка идентификатор валюты |
Пример ответа:
{
"success": true,
"result": true
}