API панели управления

Содержание

  1. Отправка запроса
  2. Отключение методов
  3. Обработка ответа
  4. Смена локализации
  5. Использование пагинации
  6. Получение списка заявок на обмен
  7. Редактирование статуса заявки на обмен
  8. Удаление заявки на обмен
  9. Получение списка заблокированных платежных реквизитов
  10. Редактирование статуса заблокированного платежного реквизита
  11. Удаление заблокированного платежного реквизита
  12. Блокировка платежного реквизита
  13. Получение списка отзывов
  14. Редактирование статуса отзыва
  15. Удаление отзыва
  16. Получение списка запросов резерва
  17. Редактирование статуса запроса резерва
  18. Удаление запроса резерва
  19. Получение списка заявок на верификацию
  20. Редактирование статуса заявки на верификацию
  21. Удаление заявки на верификацию
  22. Получение списка инвестиций
  23. Удаление инвестиции
  24. Получение списка пользователей
  25. Редактирование статуса пользователя
  26. Удаление пользователя
  27. Редактирование пользователя
  28. Получение списка валют
  29. Редактирование статуса валюты
  30. Удаление валюты
  31. Редактирование валюты
  32. Получение списка направлений обмена
  33. Редактирование статуса направления обмена
  34. Редактирование направления обмена
  35. Удаление направления обмена
  36. Управление статусом оператора
  37. Получение статуса режима технических работ
  38. Управление статусом режима технических работ
Отправка запроса

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)

Работаем в свободном графике

© 2018 - 2023 Сделано с Exchanger CMS 🇺🇦

Telegram чат Обратная связь

Мы в социальных сетях