Содержание
- Отправка запроса
- Отключение методов
- Обработка ответа
- Смена локализации
- Использование пагинации
- Получение списка заявок на обмен
- Редактирование статуса заявки на обмен
- Удаление заявки на обмен
- Получение списка заблокированных платежных реквизитов
- Редактирование статуса заблокированного платежного реквизита
- Удаление заблокированного платежного реквизита
- Блокировка платежного реквизита
- Получение списка отзывов
- Редактирование статуса отзыва
- Удаление отзыва
- Получение списка запросов резерва
- Редактирование статуса запроса резерва
- Удаление запроса резерва
- Получение списка заявок на верификацию
- Редактирование статуса заявки на верификацию
- Удаление заявки на верификацию
- Получение списка инвестиций
- Удаление инвестиции
- Получение списка пользователей
- Редактирование статуса пользователя
- Удаление пользователя
- Редактирование пользователя
- Получение списка валют
- Редактирование статуса валюты
- Удаление валюты
- Редактирование валюты
- Получение списка направлений обмена
- Редактирование статуса направления обмена
- Редактирование направления обмена
- Удаление направления обмена
- Управление статусом оператора
- Получение статуса режима технических работ
- Управление статусом режима технических работ
API панели управления предоставляет возможность доступа и управления различными данными сайта. Для работы с API необходима аутентификация с использованием секретного ключа полученного в разделе "Настройки приложения" — "Настройка API панели управления" — "Секретный ключ".
Секретный ключ необходимо отправлять в HTTP-заголовке "X-Authorization". Работа с API подразумевает отправку POST-запроса на URL адрес нужного метода.
Пример запроса:
curl -X POST 'https://demo.exchanger-cms.com/dashboard-api-get-orders' \
--header 'X-Authorization: **********'
Вы можете полностью закрыть доступ к API панели управления в разделе "Настройки приложения" — "Настройка API панели управления".
Пример успешного ответа:
{
"success": true,
"result": [
"data"
]
}
Пример неуспешного ответа:
{
"success": false,
"message": "Текст ошибки",
"result": false
}
Для смены локализации добавьте параметр "language" с кодом языка.
Для пагинации списков используйте параметр "page" с номером позиции. Если вы хотите изменить количество объектов на странице, используйте параметр "limit".
Пример ответа с пагинацией:
{
"success": true,
"pagination": [
200,
50
],
"result": [
"data"
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Всего объектов |
| 1 | Текущая позиция |
/dashboard-api-get-orders
Необязательные параметры для поиска: id, token, status, exchange_id, user_id, referral_id, ip, country, browser, send_merchant, receive_merchant, send_currency_id, receive_currency_id.
В случае успеха возвращается объект заявки на обмен.
/dashboard-api-set-order-status
| Параметр | Описание |
|---|---|
| id | Идентификатор или токен |
| status | Идентификатор статуса |
| txn | Номер транзакции оплаты или выплаты (необязательно) |
/dashboard-api-delete-order
| Параметр | Описание |
|---|---|
| id | Идентификатор |
/dashboard-api-get-details-banned
Необязательные параметры для поиска: id, active, currency_id.
В случае успеха возвращается объект заблокированного платежного реквизита.
/dashboard-api-set-detail-banned-status
| Параметр | Описание |
|---|---|
| id | Идентификатор |
| active | Заблокирован (да: 1, нет: 0) |
/dashboard-api-delete-detail-banned
| Параметр | Описание |
|---|---|
| id | Идентификатор |
/dashboard-api-create-detail-banned
| Параметр | Описание |
|---|---|
| currency_id | Идентификатор валюты |
| detail | Платежные реквизиты |
| reason | Причина блокировка (необязательно) |
В случае успеха возвращается объект заблокированного платежного реквизита.
/dashboard-api-get-reviews
Необязательные параметры для поиска; active, name, email, ip, country.
В случае успеха возвращается объект отзыва.
/dashboard-api-set-review-status
| Параметр | Описание |
|---|---|
| id | Идентификатор |
| active | На модерации (нет: 1, да: 0) |
/dashboard-api-delete-review
| Параметр | Описание |
|---|---|
| id | Идентификатор |
/dashboard-api-get-reserves-request
Необязательные параметры для поиска: id, active, token, currency_id, email, ip, country.
В случае успеха возвращается объект запроса резерва.
/dashboard-api-set-reserve-request-status
| Параметр | Описание |
|---|---|
| id | Идентификатор |
| active | Обработан (нет: 1, да: 0) |
/dashboard-api-delete-reserve-request
/dashboard-api-get-verifications
Необязательные параметры для поиска: id, active, token, user_id, id_type.
В случае успеха возвращается объект заявки на верификацию.
/dashboard-api-set-verification-status
| Параметр | Описание |
|---|---|
| id | Идентификатор |
| active | Проверена (да: 1, нет: 0) |
/dashboard-api-delete-verification
| Параметр | Описание |
|---|---|
| id | Идентификатор |
/dashboard-api-get-investments
Необязательные параметры для поиска: id, active, token, user_id.
В случае успеха возвращается объект инвестиции.
/dashboard-api-delete-investment
| Параметр | Описание |
|---|---|
| id | Идентификатор |
/dashboard-api-get-users
Необязательные параметры для поиска: id, active, verified, ip, country, login, email, password, referral_id, api_token.
В случае успеха возвращается объект пользователя.
/dashboard-api-set-user-status
| Параметр | Описание |
|---|---|
| id | Идентификатор |
| active | Заблокирован (нет: 1, да: 0) |
/dashboard-api-delete-user
| Параметр | Описание |
|---|---|
| id | Идентификатор |
/dashboard-api-update-user
| Параметр | Описание |
|---|---|
| verified | Верифицирован (да: 1, нет: 0) |
| balance | Баланс (число) |
| registration_token | Токен подтверждения регистрации (32 латинских символа или цифр) |
| password_reset_token | Токен подтверждения сброса пароля (32 латинских символа или цифр) |
| api_token | API токен (32 латинских символа или цифр) |
| authorization_token | Токен 2FA (16 латинских символов или цифр в верхнем регистре) |
/dashboard-api-get-currencies
Необязательные параметры для поиска: id, active, slug, iso, round, label, detail.
В случае успеха возвращается объект валюты.
/dashboard-api-set-currency-status
| Параметр | Описание |
|---|---|
| id | Идентификатор |
| active | Активна (да: 1, нет: 0) |
/dashboard-api-delete-currency
| Параметр | Описание |
|---|---|
| id | Идентификатор |
/dashboard-api-update-currency
| Параметр | Описание |
|---|---|
| id | Идентификатор |
| reserve | Резерв валюты (число) |
| detail | Платежные реквизиты |
/dashboard-api-get-exchanges
Необязательные параметры для поиска: id, active, slug, send_merchant, receive_merchant, send_currency_id, receive_currency_id, parser.
В случае успеха возвращается объект направления обмена.
/dashboard-api-set-exchange-status
| Параметр | Описание |
|---|---|
| id | Идентификатор |
| active | Активно (да: 1, нет: 0) |
/dashboard-api-update-exchange
| Параметр | Описание |
|---|---|
| id | Идентификатор |
| send_rate | Курс обмена отдаваемой валюты |
| receive_rate | Курс обмена получаемой валюты |
/dashboard-api-delete-exchange
| Параметр | Описание |
|---|---|
| id | Идентификатор |
/dashboard-api-set-operator-status
| Параметр | Описание |
|---|---|
| online | В сети (да: 1, нет: 0) |
/dashboard-api-get-maintenance-mode
Пример ответа:
{
"success": true,
"result": 1
}
/dashboard-api-set-maintenance-mode
| Параметр | Описание |
|---|---|
| enabled | Технические работы (да: 1, нет: 0) |