Публичное API
Содержание
- Отправка запроса
- Отключение методов
- Обработка ответа
- Смена локализации
- Получение последних новостей
- Получение курсов популярных валют
- Получение доступных языков
- Получение данных о направлениях обмена
- Получение данных о направлении обмена
- Получение данных о валюте
- Получение социальной информации
- Получение статуса сервиса
- Получение ставки по реферальной программе
- Получение баннеров и промо-материалов
- Получение ставки по системе бонусов
- Получение ставки по инвестиционной программе
- Получение информации о внутренней валюте системы
- Получение информации о скрипте
Отправка запроса
Публичное API предоставляет возможность доступа к различным данным без предварительной аутентификации. Работа с API подразумевает отправку GET запроса на URL адрес нужного метода. Ответ сервера представлен в формате JSON.
Отключение методов
Вы можете полностью закрыть доступ или отключить некоторые методы публичного API в разделе "Настройки приложения" — "Настройка публичного API".
Обработка ответа
Пример успешного ответа:
{
"success": true,
"result": [
"data"
]
}
Пример неуспешного ответа:
{
"success": false,
"result": false
}
Смена локализации
Для смены локализации добавьте параметр "language" с двухбуквенный кодом языка в качестве значения. По умолчанию используется язык, который установлен в разделе "Настройки приложения" — "Настройка языка".
Список доступных языков можно получить используя метод публичного API "/public-api-get-languages".
Получение последних новостей
Метод:
/public-api-get-latest-news
Пример запроса:
curl -X GET 'https://demo.exchanger-cms.com/public-api-get-latest-news'
Пример ответа:
{
"success": true,
"result": [
[
1568883600,
"turkey-announces-plans-for-a-national-blockchain-infrastructure",
"Турция создаст национальную блокчейн-платформу",
"Власти Турции объявили о создании национальной блокчейн-инфраструктуры, в рамках которой технолог..."
]
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Дата публикации в формате Unix Timestamp |
| 1 | Строка идентификатор |
| 2 | Заголовок |
| 3 | Короткое описание |
Максимальное количество последних новостей можно установить в разделе "Настройки шаблона" - "Настройка оформления и виджетов".
Получение курсов популярных валют
Метод:
/public-api-get-rates
Пример запроса:
curl -X GET 'https://demo.exchanger-cms.com/public-api-get-rates'
Не обязательные параметры запроса:
| Параметр | Описание |
|---|---|
| base | Код базовой валюты (по умолчанию USD) |
Пример ответа:
{
"success": true,
"result": {
"ETH": 210.3711,
"DAI": 1,
"BTC": 9588.9484,
"UAH": 0.0371,
"USD": 1,
"USDT": 1
}
}
Получение доступных языков
Метод:
/public-api-get-languages
Пример запроса:
curl -X GET 'https://demo.exchanger-cms.com/public-api-get-languages'
Пример ответа:
{
"success": true,
"result": ["en", "ru"]
}
Получение данных о направлениях обмена
Метод:
/public-api-get-exchanges
Пример запроса:
curl -X GET 'https://demo.exchanger-cms.com/public-api-get-exchanges'
Пример ответа:
{
"success": true,
"result": {
"1": {
"2": "zec-yamrub",
"3": "zec-xrp",
"4": "zec-xmr"
}
}
}
Обработка ответа:
Ответ содержит массив с идентификаторами валют в качестве ключа и вложенный массив доступных направлений обмена в качестве значения, который состоит из идентификатора валюты и строки идентификатора направления обмена.
Полный список идентификаторов валют можно получить при помощи метода "/public-api-get-currencies".
Получение данных о направлении обмена
Метод:
/public-api-get-exchange?pair={slug}
Пример запроса:
curl -X GET 'https://demo.exchanger-cms.com/public-api-get-exchange?pair=eth-usdt'
Параметры запроса:
| Параметр | Описание |
|---|---|
| pair | Строка идентификатор направления обмена |
Пример ответа:
{
"success": true,
"result": [
"eth-usdt",
52,
19,
"ETH",
"USDT",
"Ethereum",
"Tether",
"1 ETH",
"531.33101 USDT",
8,
8,
"0.01000000 ETH",
"4131.71428571 USDT",
null,
"/site-default/icon-eth.png",
"/site-default/icon-usdt.png",
"",
"Адрес",
"Адрес",
"",
"",
[
1,
6
],
0,
14,
0,
null,
1,
0,
0,
0.01,
0,
0,
1,
531.33101
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Строка идентификатор |
| 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 | Тип минимальной суммы обмена (1 - отдаваемая валюта, 2 - получаемая валюта) |
| 27 | Тип максимальной суммы обмена (1 - отдаваемая валюта, 2 - получаемая валюта) |
| 28 | Тип дополнительной комиссии (1 - отдаваемая валюта, 2 - получаемая валюта) |
| 29 | Минимальная сумма обмена |
| 30 | Максимальная сумма обмена |
| 31 | Сумма дополнительной комиссии |
| 32 | Курс обмена отдаваемой валюты |
| 33 | Курс обмена получаемой валюты |
| 34 | Резерв получаемой валюты |
Получение данных о валюте
Метод:
/public-api-get-currencies
Пример запроса:
curl -X GET 'https://demo.exchanger-cms.com/public-api-get-currencies'
Пример ответа:
{
"success": true,
"result": [
[
52,
"ETH",
"ETH",
"Ethereum",
"Адрес",
"",
59.52899404,
8,
"/site-default/icon-eth.png",
"cryptocurrency"
]
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Идентификатор валюты |
| 1 | Строка идентификатор валюты |
| 2 | Код валюты |
| 3 | Название валюты |
| 4 | Название поля валюты на странице обмена |
| 5 | Подсказка поля валюты на странице обмена |
| 6 | Резерв валюты |
| 7 | Количество знаков после запятой валюты |
| 8 | Путь к иконке валюты |
| 9 | Метка |
Получение социальной информации
Метод:
/public-api-get-social
Пример запроса:
curl -X GET 'https://demo.exchanger-cms.com/public-api-get-social'
Пример ответа:
{
"success": true,
"result": [
"Exchanger CMS",
"[email protected]",
"",
"https://t.me/exchangerCMS",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"https://twitter.com/exchangerCMS",
"https://www.youtube.com/channel/UCyo7IJYghqjZPwHtTKIxlTw",
""
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Название |
| 1 | Электронная почта |
| 2 | Номер телефона |
| 3 | Telegram |
| 4 | Skype |
| 5 | Viber |
| 6 | |
| 7 | Messenger |
| 8 | Discord |
| 9 | Snapchat |
| 10 | Вконтакте |
| 11 | Одноклассники |
| 12 | |
| 13 | |
| 14 | YouTube |
| 15 |
Получение статуса сервиса
Метод:
/public-api-get-status
Пример запроса:
curl -X GET 'https://demo.exchanger-cms.com/public-api-get-status'
Пример ответа:
{
"success": true,
"result": [
"Europe/Moscow",
false,
false
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Временная зона |
| 1 | Статус оператора |
| 2 | Создание заявок на обмен приостановлено |
Получение ставки по реферальной программе
Метод:
/public-api-get-referral-program
Пример запроса:
curl -X GET 'https://demo.exchanger-cms.com/public-api-get-referral-program'
Пример ответа:
{
"success": true,
"result": [
[
100,
0.1
],
[
1000,
0.2
]
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Оборот обменов рефералов |
| 1 | Вознаграждение от суммы обмена в процентах |
Получение баннеров и промо-материалов
Метод:
/public-api-get-banners
Пример запроса:
curl -X GET 'https://demo.exchanger-cms.com/public-api-get-banners'
Пример ответа:
{
"success": true,
"result": [
[
"/site-default/banner-ru-728x90.png",
728,
90
]
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Относительный путь к изображению |
| 1 | Ширина изображения |
| 2 | Высота изображения |
Получение ставки по системе бонусов
Метод:
/public-api-get-bonus-system
Пример запроса:
curl -X GET 'https://demo.exchanger-cms.com/public-api-get-bonus-system'
Пример ответа:
{
"success": true,
"result": [
[
100,
0.01
],
[
1000,
0.02
]
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Оборот обменов |
| 1 | Бонус от суммы обмена в процентах |
Получение ставки по инвестиционной программе
Метод:
/public-api-get-investment-program
Пример запроса:
curl -X GET 'https://demo.exchanger-cms.com/public-api-get-investment-program'
Пример ответа:
{
"success": true,
"result": [
[
30,
2,
100,
10000
],
[
90,
9,
100,
10000
]
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Период инвестирования в днях |
| 1 | Доходность в процентах за весь период |
| 2 | Минимальная сумма инвестирования |
| 3 | Максимальная сумма инвестирования |
Получение информации о внутренней валюте системы
Метод:
/public-api-get-balance
Пример запроса:
curl -X GET 'https://demo.exchanger-cms.com/public-api-get-balance'
Пример ответа:
{
"success": true,
"result": [
"USD",
"USD",
"2",
[
{
"advcusd-balanceusd": [
"Advanced Cash USD",
"Balance USD",
"1 USD",
"1 USD",
"1.00 USD",
"82997.60 USD",
"0.50 %",
"Направление обмена включает дополнительную комиссию для получаемой валюты в размере 0.50 %",
77,
76,
"/site-default/icon-advcusd.png",
"/site-default/icon-balance.png"
]
},
{
"balanceusd-advcusd": [
"Balance USD",
"Advanced Cash USD",
"1 USD",
"1 USD",
"1.00 USD",
"31896.00 USD",
null,
null,
76,
77,
"/site-default/icon-balance.png",
"/site-default/icon-advcusd.png"
]
}
]
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Валюта баланса |
| 1 | Символ валюты баланса |
| 2 | Количество знаков после запятой |
| 3 | Массив направлений обмена |
| 3[0] | Название отдаваемой валюты |
| 3[1] | Название получаемой валюты |
| 3[2] | Курс отдаваемой валюты, включая код валюты |
| 3[3] | Курс получаемой валюты, включая код валюты |
| 3[4] | Минимальная сумма обмена, включая код валюты |
| 3[5] | Максимальная сумма обмена, включая код валюты |
| 3[6] | Сумма дополнительной комиссии, включая код валюты / % |
| 3[7] | Описание для дополнительной комиссии |
| 3[8] | Идентификатор отдаваемой валюты |
| 3[9] | Идентификатор получаемой валюты |
| 3[10] | Путь к иконке отдаваемой валюты |
| 3[11] | Путь к иконке получаемой валюты |
Получение информации о скрипте
Метод:
/public-api-get-software
Пример запроса:
curl -X GET 'https://demo.exchanger-cms.com/public-api-get-software'
Пример ответа:
{
"success": true,
"result": [
"exchanger-cms.com",
"1.5.0",
"2b751976d4bec70186bd28246843831d"
]
}
Обработка ответа:
| # | Описание |
|---|---|
| 0 | Сайт разработчика |
| 1 | Текущая версия |
| 2 | Серийный номер |