API панели управления
API панели управления предоставляет возможность доступа и управления различными данными.
API панели управления можно активировать / деактивировать в панеле управления в разделе "Настройки приложения" — "Настройка API панели управления".
Аутентификация
Для работы с API необходима аутентификация с использованием секретного ключа полученного в панеле управления в разделе "Настройки приложения" — "Настройка API панели управления". Секретный ключ необходимо отправлять в HTTP заголовке X-Authorization.
Доступные методы
Работа с API подразумевает отправку POST запроса на URL адрес нужного метода:
| Метод | Описание метода |
|---|---|
| dashboard-api-get-orders | Получение списка заявок на обмен |
| dashboard-api-get-order | Получение информации о заявке на обмен |
| dashboard-api-set-order-status | Изменение статуса заявки на обмен |
| dashboard-api-delete-order | Удаление заявки на обмен |
| dashboard-api-get-details-banned | Получение списка заблокированных платежных реквизитов |
| dashboard-api-get-detail-banned | Получение информации о заблокированном платежном реквизите |
| dashboard-api-set-detail-banned-status | Изменение статуса для заблокированного платежного реквизита |
| dashboard-api-delete-detail-banned | Удаление заблокированного платежного реквизита |
| dashboard-api-create-detail-banned | Блокировка платежного реквизита |
| dashboard-api-get-reviews | Получение списка отзывов |
| dashboard-api-get-review | Получение информации об отзыве |
| dashboard-api-set-review-status | Изменение статуса отзыва |
| dashboard-api-delete-review | Удаление отзыва |
| dashboard-api-get-reserves-request | Получение списка заявок на запрос резерва |
| dashboard-api-get-reserve-request | Получение информации о заявке на запрос резерва |
| dashboard-api-set-reserve-request-status | Изменение статуса заявки на запрос резерва |
| dashboard-api-delete-reserve-request | Удаление заявки на запрос резерва |
| dashboard-api-get-verifications | Получение списка заявок на запрос верификации |
| dashboard-api-get-verification | Получение информации о заявке на запрос верификации |
| dashboard-api-set-verification-status | Изменение статуса заявки на запрос верификации |
| dashboard-api-delete-verification | Удаление заявки на запрос верификации |
| dashboard-api-get-investments | Получение списка инвестиционных пакетов |
| dashboard-api-get-investment | Получение информации об инвестиционном пакете |
| dashboard-api-delete-investment | Удаление инвестиционного пакета |
| dashboard-api-get-users | Получение списка пользователей |
| dashboard-api-get-user | Получение информации о пользователе |
| dashboard-api-set-user-status | Изменение статуса пользователя |
| dashboard-api-delete-user | Удаление пользователя |
| dashboard-api-update-user | Изменение данных пользователя |
| dashboard-api-get-currencies | Получение списка валют |
| dashboard-api-get-currency | Получение информации о валюте |
| dashboard-api-set-currency-status | Изменение статуса валюты |
| dashboard-api-delete-currency | Удаление валюты |
| dashboard-api-update-currency | Изменение данных валюты |
| dashboard-api-get-exchanges | Получение списка направлений обмена |
| dashboard-api-get-exchange | Получение информации о направлении обмена |
| dashboard-api-set-exchange-status | Изменение статуса направления обмена |
| dashboard-api-delete-exchange | Удаление направления обмена |
| dashboard-api-set-operator-status | Изменение статуса оператора |
| dashboard-api-set-maintenance-mode | Изменение статуса режима технических работ |
Пример URL адреса для отправки запроса:
https://demo.exchanger-cms.com/dashboard-api-get-order
Обработка ответов
Пример успешного ответа:
{
"success":true,
"result":["data"]
}Пример неуспешного ответа:
{
"success":false,
"result":false
}Ответ сервера представлен в формате json.
Пагинация
Некоторые методы используют пагинацию при возврате данных. Для перехода между результатами добавьте параметр page с номером позиции в качестве значения.
Пример ответа с использованием пагинации:
{
"success":true,
"pagination":[200,50],
"result":["data"]
}Обработка ответа:
| # | Описание индекса |
|---|---|
| 0 | Общее количество элементов |
| 1 | Количество элементов для текущей позиции |
Метод dashboard-api-get-orders
Пример ответа:
{
"success":true,
"pagination": [2,2],
"result":[
[85,"127.0.0.1","US","126f9f9cdd26cccb25da2f078cda6536",0,"ru",8,0,"","",{"0":"U6375940","1":"U675474747127","6":"[email protected]"},40,77,"PMUSD","USD","USD","ADVCUSD",1.0201,1,100,98.03,2,2,1,0,0,0,1585636634],
[84,"127.0.0.1","GB","9f4ed52526aac96b417f6303998faa78",0,"ru",1,0,"","",{"1":"U675474747127","6":"[email protected]"},76,77,"BALANCEUSD","USD","USD","ADVCUSD",1,1,100,100,2,2,1,0,0,0,1585553977]
]
}Обработка ответа полностью соответствует формату веб-хуков.
Метод dashboard-api-get-order
Параметры запроса:
| Параметр | Описание параметра |
|---|---|
| id | Идентификатор |
Пример ответа:
{
"success":true,
"result":[85,"127.0.0.1","US","126f9f9cdd26cccb25da2f078cda6536",0,"ru",8,0,"","",{"0":"U6375940","1":"U675474747127","6":"[email protected]"},40,77,"PMUSD","USD","USD","ADVCUSD",1.0201,1,100,98.03,2,2,1,0,0,0,1585636634]
}Обработка ответа полностью соответствует формату веб-хуков.
Метод dashboard-api-set-order-status
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор |
| status | Идентификатор статуса |
| txn | Номер транзакции оплаты/выплаты (не обязательно) |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-delete-order
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-get-details-banned
Пример ответа:
{
"success":true,
"pagination": [2,2],
"result":[
[2,1,80,"ETH","ETH","0xEa1bba4E9e635ffC6533A2e086C80187A896db59",""],
[1,1,12,"QWRUB","RUB","712345678","Отмывание средств"]
]
}Обработка ответа полностью соответствует формату веб-хуков.
Метод dashboard-api-get-detail-banned
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор |
Пример ответа:
{
"success":true,
"result":[2,1,80,"ETH","ETH","0xEa1bba4E9e635ffC6533A2e086C80187A896db59",""]
}Обработка ответа полностью соответствует формату веб-хуков.
Метод dashboard-api-set-detail-banned-status
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор |
| active | Статус (активен: 1/0) |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-delete-detail-banned
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-create-detail-banned
Параметры запроса:
| Параметр | Описание |
|---|---|
| currency_id | Идентификатор валюты |
| detail | Реквизиты |
| detail | Причина блокировка (не обязательно) |
Пример ответа:
{
"success":true,
"result":[3]
}Обработка ответа:
| # | Описание индекса |
|---|---|
| 0 | Идентификатор |
Метод dashboard-api-get-reviews
Пример ответа:
{
"success":true,
"pagination": [1,1],
"result":[
[105,"127.0.0.1","RU",1,"ru","[email protected]","Сергей","Все супер!!!и быстро главное.",1585635787]
]
}Обработка ответа полностью соответствует формату веб-хуков.
Метод dashboard-api-get-review
Параметры запроса:
| Параметр | Описание параметра |
|---|---|
| id | Идентификатор |
Пример ответа:
{
"success":true,
"result":[105,"127.0.0.1","RU",1,"ru","[email protected]","Сергей","Все супер!!!и быстро главное.",1585635787]
}Обработка ответа полностью соответствует формату веб-хуков.
Метод dashboard-api-set-review-status
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор |
| active | Статус (активен: 1/0) |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-delete-review
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-get-reserves-request
Пример ответа:
{
"success":true,
"pagination": [1,1],
"result":[
[7,"138.68.153.210","GB","3d7f3106154564f006a47a8aa9bf8638",0,"ru",52,"ETH","ETH",8,183.6378,"[email protected]",1585553489]
]
}Обработка ответа полностью соответствует формату веб-хуков.
Метод dashboard-api-get-reserve-request
Параметры запроса:
| Параметр | Описание параметра |
|---|---|
| id | Идентификатор |
Пример ответа:
{
"success":true,
"result":[7,"138.68.153.210","GB","3d7f3106154564f006a47a8aa9bf8638",0,"ru",52,"ETH","ETH",8,183.6378,"[email protected]",1585553489]
}Обработка ответа полностью соответствует формату веб-хуков.
Метод dashboard-api-set-reserve-request-status
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор |
| active | Статус (активен: 1/0) |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-delete-reserve-request
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-get-verifications
Пример ответа:
{
"success":true,
"pagination": [1,1],
"result":[
[1,"a91050ed758ebcb97a4c5e9ee68b07e2",0,2,"demo2","[email protected]",0,"02414567891","Александра","","Александровна",192142800,"78645352003","Россия","Петропавловск","Большесосновский р-н, Пермский край","050483",1575531715]
]
}Обработка ответа полностью соответствует формату веб-хуков.
Метод dashboard-api-get-verification
Параметры запроса:
| Параметр | Описание параметра |
|---|---|
| id | Идентификатор |
Пример ответа:
{
"success":true,
"result":[1,"a91050ed758ebcb97a4c5e9ee68b07e2",0,2,"demo2","[email protected]",0,"02414567891","Александра","","Александровна",192142800,"78645352003","Россия","Петропавловск","Большесосновский р-н, Пермский край","050483",1575531715]
}Обработка ответа полностью соответствует формату веб-хуков.
Метод dashboard-api-set-verification-status
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор |
| active | Статус (активен: 1/0) |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-delete-verification
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-get-investments
Пример ответа:
{
"success":true,
"pagination": [1,1],
"result":[
[12,"8b2341cc6b16134b0ab203761f074778",1,1,"demo","[email protected]",1000,0,2,30,1600581552,1603173552,1603173552]
]
}Обработка ответа полностью соответствует формату веб-хуков.
Метод dashboard-api-get-investment
Параметры запроса:
| Параметр | Описание параметра |
|---|---|
| id | Идентификатор |
Пример ответа:
{
"success":true,
"result":[12,"8b2341cc6b16134b0ab203761f074778",1,1,"demo","[email protected]",1000,0,2,30,1600581552,1603173552,1603173552]
}Обработка ответа полностью соответствует формату веб-хуков.
Метод dashboard-api-delete-investment
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-get-users
Пример ответа:
{
"success":true,
"pagination": [1,1],
"result":[
[120,"115.35.34.13","US",1,0,"brouser","[email protected]","bc072a77a91e28eb8d2dfc9461d4b991","",1600448471,"1.00 USD",null,null,null,null,null,0,null,""]
]
}Обработка ответа полностью соответствует формату веб-хуков.
Метод dashboard-api-get-user
Параметры запроса:
| Параметр | Описание параметра |
|---|---|
| id | Идентификатор |
Пример ответа:
{
"success":true,
"result":[120,"115.35.34.13","US",1,0,"brouser","[email protected]","bc072a77a91e28eb8d2dfc9461d4b991","",1600448471,"1.00 USD",null,null,null,null,null,0,null,""]
}Обработка ответа полностью соответствует формату веб-хуков.
Метод dashboard-api-set-user-status
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор |
| active | Статус (активен: 1/0) |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-delete-user
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-update-user
Параметры запроса:
| Параметр | Описание |
|---|---|
| verified | Статус верификации (активен: 1/0) |
| balance | Баланс (число больше нуля) |
| registrationToken | Токен подтверждения регистрации (32 латинских символа или цифр) |
| passwordResetToken | Токен подтверждения сброса пароля (32 латинских символа или цифр) |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-get-currencies
Пример ответа:
{
"success":true,
"pagination": [1,1],
"result":[
[52,1,"ETH","ETH","Ethereum","Адрес","",65.23809524,8,"/site-default/icon-eth.png","cryptocurrency","0x61AF7c11DB9ae32edd532Dc87eCfD04B76C07FA7"]
]
}Обработка ответа:
| # | Описание индекса |
|---|---|
| 0 | Идентификатор валюты |
| 1 | Статус валюты (активен: 1/0) |
| 2 | Строка идентификатор валюты |
| 3 | Код валюты по стандарту ISO |
| 4 | Название валюты |
| 5 | Название поля валюты на странице обмена |
| 6 | Подсказка поля валюты на странице обмена |
| 7 | Резерв валюты |
| 8 | Количество знаков после запятой валюты |
| 9 | Путь к иконке валюты |
| 10 | Метка |
| 11 | Платежные реквизиты валюты |
Метод dashboard-api-get-currency
Параметры запроса:
| Параметр | Описание параметра |
|---|---|
| id | Идентификатор валюты |
Пример ответа:
{
"success":true,
"result":[52,1,"ETH","ETH","Ethereum","Адрес","",65.23809524,8,"/site-default/icon-eth.png","cryptocurrency","0x61AF7c11DB9ae32edd532Dc87eCfD04B76C07FA7"]
}Обработка ответа полностью соответствует формату метода dashboard-api-get-currencies.
Метод dashboard-api-set-currency-status
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор валюты |
| active | Статус валюты (активен: 1/0) |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-delete-currency
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор валюты |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-update-currency
Параметры запроса:
| Параметр | Описание |
|---|---|
| reserve | Резерв валюты (число больше нуля) |
| detail | Платежные реквизиты валюты |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-get-exchanges
Пример ответа:
{
"success":true,
"pagination": [1,1],
"result":[
[345,1,"eth-usdt",52,19,"ETH","USDT","Ethereum","Tether","1 ETH","336.6355 USDT",8,8,"0.01000000 ETH","4332.85555416 USDT",null,"\/site-default\/icon-eth.png","\/site-default\/icon-usdt.png","<h4 class=\"font-w300\">Как произвести обмен Ethereum на Tether?<\/h4><p>Для обмена вам необходимо выполнить несколько шагов:<\/p>1. Заполните все поля представленной формы. Нажмите кнопку «Продолжить».<br>2. Ознакомьтесь с условиями договора на оказание услуг обмена, если вы принимаете их, поставьте галочку в соответствующем поле\/нажмите кнопку «Я принимаю соглашение». Еще раз проверьте данные заявки.<br>3. Оплатите заявку. Для этого следует совершить перевод необходимой суммы, следуя инструкциям на нашем сайте.<br>4. После выполнения указанных действий, система переместит вас на страницу «Состояние заявки», где будет указан статус вашего перевода.","Адрес","Адрес","","",[1,6],0,14,0,null,1,0,0,1,0,0,1,336.6355]
]
}Обработка ответа:
| # | Описание индекса |
|---|---|
| 0 | Идентификатор направления обмена |
| 1 | Статус направления обмена (активен: 1/0) |
| 2 | Строка идентификатор направления обмена |
| 3 | Идентификатор отдаваемой валюты |
| 4 | Идентификатор получаемой валюты |
| 5 | Код отдаваемой валюты в стандарте ISO 4217 |
| 6 | Код получаемой валюты в стандарте ISO 4217 |
| 7 | Название отдаваемой валюты |
| 8 | Название получаемой валюты |
| 9 | Курс обмена отдаваемой валюты, включая код валюты |
| 10 | Курс обмена получаемой валюты, включая код валюты |
| 11 | Количество знаков после запятой отдаваемой валюты |
| 12 | Количество знаков после запятой получаемой валюты |
| 13 | Минимальная сумма обмена, включая код валюты |
| 14 | Максимальная сумма обмена, включая код валюты |
| 15 | Сумма дополнительной комиссии направления обмена, включая код валюты |
| 16 | Путь к иконке отдаваемой валюты |
| 17 | Путь к иконке получаемой валюты |
| 18 | Описание направления обмена |
| 19 | Название поля отдаваемой валюты на странице обмена |
| 20 | Название поля получаемой валюты на странице обмена |
| 21 | Подсказка поля отдаваемой валюты на странице обмена |
| 22 | Подсказка поля получаемой валюты на странице обмена |
| 23 | Массив идентификаторов полей на странице обмена |
| 24 | Комиссия платежной системы (мерчанта) |
| 25 | Идентификатор мерчанта обработки входящих платежей |
| 26 | Идентификатор мерчанта обработки исходящих платежей |
| 26 | Тип минимальной суммы обмена (1 - отдаваемая валюта, 2 - получаемая валюта) |
| 27 | Тип максимальной суммы обмена (1 - отдаваемая валюта, 2 - получаемая валюта) |
| 28 | Тип дополнительной комиссии (1 - отдаваемая валюта, 2 - получаемая валюта) |
| 29 | Минимальная сумма обмена |
| 30 | Максимальная сумма обмена |
| 31 | Сумма дополнительной комиссии |
| 32 | Курс обмена отдаваемой валюты |
| 33 | Курс обмена получаемой валюты |
Метод dashboard-api-get-exchange
Параметры запроса:
| Параметр | Описание параметра |
|---|---|
| id | Идентификатор направления обмена |
Пример ответа:
{
"success":true,
"result":[345,1,"eth-usdt",52,19,"ETH","USDT","Ethereum","Tether","1 ETH","336.6355 USDT",8,8,"0.01000000 ETH","4332.85555416 USDT",null,"\/site-default\/icon-eth.png","\/site-default\/icon-usdt.png","<h4 class=\"font-w300\">Как произвести обмен Ethereum на Tether?<\/h4><p>Для обмена вам необходимо выполнить несколько шагов:<\/p>1. Заполните все поля представленной формы. Нажмите кнопку «Продолжить».<br>2. Ознакомьтесь с условиями договора на оказание услуг обмена, если вы принимаете их, поставьте галочку в соответствующем поле\/нажмите кнопку «Я принимаю соглашение». Еще раз проверьте данные заявки.<br>3. Оплатите заявку. Для этого следует совершить перевод необходимой суммы, следуя инструкциям на нашем сайте.<br>4. После выполнения указанных действий, система переместит вас на страницу «Состояние заявки», где будет указан статус вашего перевода.","Адрес","Адрес","","",[1,6],0,14,0,null,1,0,0,1,0,0,1,336.6355]
}Обработка ответа полностью соответствует формату метода dashboard-api-get-exchanges.
Метод dashboard-api-set-exchange-status
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор валюты |
| active | Статус направления обмена (активен: 1/0) |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-delete-exchange
Параметры запроса:
| Параметр | Описание |
|---|---|
| id | Идентификатор направления обмена |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-set-operator-status
Параметры запроса:
| Параметр | Описание |
|---|---|
| online | Статус оператора (активен: 1/0) |
Пример ответа:
{
"success":true,
"result":true
}Метод dashboard-api-set-maintenance-mode
Параметры запроса:
| Параметр | Описание |
|---|---|
| enabled | Статус режима технических работ (активен: 1/0) |
Пример ответа:
{
"success":true,
"result":true
}График работы пн. — вс. 08:00 — 20:00 (GMT+03:00)
Сделано с от Exchanger CMS © 2019 - 2020
Telegram чатОбратная связь