Содержание
- Отправка запроса
- Отключение методов
- Обработка ответа
- Смена локализации
- Использование пагинации
- Информация о пользователе
- История обменов
- История реферальных обменов
- История инвестиций
- Покупка инвестиционного пакета
- Список платежных реквизитов
- Сохранение платежного реквизита
- Удаление платежного реквизита
- Информации о верификации
- Прохождение верификации
- Оплата с баланса при обмене
API пользователя предоставляет возможность доступа к различным данным аккаунта конкретного для пользователя. Для работы с API необходима аутентификация с использованием токена выпущенного в профиле пользователя.
Токен необходимо отправлять в HTTP-заголовке "X-Authorization". Работа с API подразумевает отправку POST-запроса на URL-адрес нужного метода.
Пример запроса:
curl -X POST 'https://demo.exchanger-cms.com/user-api-get-info' \
--header 'X-Authorization: 66b718871e40a56b15b828500fdb9dbf'
Вы можете полностью закрыть доступ или отключить некоторые методы API пользователя в разделе "Настройки приложения" — "Настройка API пользователя".
Пример успешного ответа:
{
"success": true,
"result": [
"data"
]
}
Пример неуспешного ответа:
{
"success": false,
"message": "Текст ошибки",
"result": false
}
Для смены локализации добавьте параметр "language" с кодом языка.
Для пагинации списков используйте параметр "page" с номером позиции. Если вы хотите изменить количество объектов на странице, используйте параметр "limit".
Пример ответа с пагинацией:
{
"success": true,
"pagination": [
200,
50
],
"result": [
"data"
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Всего объектов |
| 1 | Текущая позиция |
/user-api-get-info
В случае успеха возвращается объект пользователя.
/user-api-get-orders
Необязательные параметры для поиска: id, token, status, exchange_id, send_currency_id, receive_currency_id.
В случае успеха возвращается объект заявки на обмен.
/user-api-get-referral-orders
Необязательные параметры для поиска: id, token, status, exchange_id, send_currency_id, receive_currency_id.
В случае успеха возвращается объект заявки на обмен.
/user-api-get-investments
Необязательные параметры для поиска: id, token, active.
В случае успеха возвращается объект инвестиционного пакета.
/user-api-create-investments
| Параметр | Описание |
|---|---|
| tariff | Идентификатор тарифа |
| amount | Сумма |
| two_factor_authentication_password | Пароль 2FA (если включена 2FA) |
В случае успеха возвращается объект инвестиционного пакета.
/user-api-get-details
Необязательные параметры для поиска: currency_id, value.
В случае успеха возвращается объект платежного реквизита пользователя.
/user-api-create-details
| Параметр | Описание |
|---|---|
| currency | Строка идентификатор валюты |
| value | Платежные реквизиты |
В случае успеха возвращается объект платежного реквизита пользователя.
/user-api-delete-details
| Параметр | Описание |
|---|---|
| currency | Строка идентификатор валюты |
/user-api-get-verification
В случае успеха возвращается объект заявки на верификацию.
/user-api-submit-verification
Для верификации банковской карты обязательными полями является номер банковской карты, имя, фамилия и фотографии.
| Параметр | Описание |
|---|---|
| id_type | Идентификатор документа |
| id_number | Номер документа или банковской карты |
| first_name | Имя |
| last_name | Фамилия |
| middle_name | Среднее имя |
| birth_date | Дата рождения (формат: дд.мм.гггг) |
| phone | Номер телефона |
| country | Страна |
| city | Город |
| address | Адрес |
| zip_code | Почтовый индекс |
| photos[] | Фотографии (максимум: 9000 кб.) |
В случае успеха возвращается объект заявки на верификацию.
/user-api-spend-balance
| Параметр | Описание |
|---|---|
| token | Токен заявки на обмен |
| two_factor_authentication_password | Пароль 2FA (если включена 2FA) |