Для использования API, на сайте должен быть подключен плагин API. Также необходимо иметь действующий API-token, который разрешает использование необходимых методов.
Параметры передаются обычным методом POST. Передавать параметры JSON в теле POST запроса запрещено.
Примеры реализации: php, jquery.
Адрес URL для использования API
{SITEURL}/api/v1/{endpoint}/
Авторизация по методу GET
{SITEURL}/api/v1/{endpoint}/?api-token={YOURTOKEN}
Авторизация с помощью заголовков
{SITEURL}/api/v1/{endpoint}/
токен передается в заголовке с именем "api-token"
Языком ответа является язык сайта. Если необходимо принудительно задать язык, используйте GET-параметр с названием "lang"
{SITEURL}/api/v1/{endpoint}/?lang=en
язык должен быть включен для сайта
Доступные методы
test
тестовый метод для проверки работоспособности API
/api/v1/test/
post-параметры
результат
error_text
описание ошибки
token_type
0 - GET token, 1 - token в headers
get_currencies
список валют, доступных для обмена
/api/v1/get_currencies/
post-параметры
currency_id_give
id валюты Отдаю
currency_id_get
id валюты Получаю
результат
error_text
описание ошибки
get_directions
список направлений обмена, доступных для обмена
/api/v1/get_directions/
post-параметры
currency_id_give
id валюты Отдаю
currency_id_get
id валюты Получаю
результат
error_text
описание ошибки
direction_id
id направления обмена
currency_give_id
id валюты Отдаю
currency_give_title
название валюты Отдаю
currency_give_logo
логотип валюты Отдаю
currency_get_id
id валюты Получаю
currency_get_title
название валюты Получаю
currency_get_logo
логотип валюты Получаю
get_direction
получить направление обмена
/api/v1/get_direction/
post-параметры
direction_id
id направления обмена (*)
currency_id_give
id валюты Отдаю
currency_id_get
id валюты Получаю
результат
error_text
описание ошибки
currency_code_give
код валюты Отдаю
currency_code_get
код валюты Получаю
currency_give
валюта Отдаю
currency_get
валюта Получаю
currency_give_id
id валюты Отдаю
currency_get_id
id валюты Получаю
sum_give_com
сумма (доп. ком +комиссия ПС) Отдаю
sum_get_com
сумма (доп. ком +комиссия ПС) Получаю
com_give
текст комиссии Отдаю
com_get
текст комиссии Получаю
min_give
мин. сумма Отдаю
max_give
макс. сумма Отдаю
min_get
мин. сумма Получаю
max_get
макс. сумма Получаю
pre_fields
поля, обязательные для заполнения перед обменом
give_fields
дополнительные поля валюты отдаю
get_fields
дополнительные поля валюты получаю
dir_fields
дополнительные поля направления обмена
txt_description
Описание обмена
txt_window
Всплывающий текст перед созданием заявки
txt_special
Текст специального статуса
get_calc
калькулятор направления обмена
/api/v1/get_calc/
post-параметры
direction_id
id направления обмена (*)
calc_amount
сумма обмена (*)
calc_action
принадлежность суммы обмена [ 1 - give amount, 2 - get amount ] (*)
cd
дополнительные данные [ urlencode(http_build_query(cd_data)) ]
результат
error_text
описание ошибки
currency_code_give
код валюты Отдаю
currency_code_get
код валюты Получаю
currency_give
валюта Отдаю
currency_get
валюта Получаю
currency_give_id
id валюты Отдаю
currency_get_id
id валюты Получаю
sum_give_com
сумма (доп. ком +комиссия ПС) Отдаю
sum_get_com
сумма (доп. ком +комиссия ПС) Получаю
com_give
текст комиссии Отдаю
com_get
текст комиссии Получаю
min_give
мин. сумма Отдаю
max_give
макс. сумма Отдаю
min_get
мин. сумма Получаю
max_get
макс. сумма Получаю
changed
необходимость изменить сумму ввода
create_bid
создание заявки на обмен
/api/v1/create_bid/
post-параметры
direction_id
id направления обмена (*)
calc_amount
сумма обмена (*)
calc_action
принадлежность суммы обмена [ 1 - give amount, 2 - get amount ] (*)
api_id
id из api (уникальное значение)
*
данные полей из метода "get_direction"
результат
error_text
описание ошибки
bid_info
получить информацию о заявке на обмен
/api/v1/bid_info/
post-параметры
результат
error_text
описание ошибки
status_title
название статуса заявки
status_descr
описание статуса заявки
psys_give
платежная система Отдаю
psys_get
платежная система Получаю
currency_code_give
код валюты Отдаю
currency_code_get
код валюты Получаю
currency_give
валюта Отдаю
currency_get
валюта Получаю
currency_give_id
id валюты Отдаю
currency_get_id
id валюты Получаю
instruction
инструкция по оплате
info
информация о платёжном счёте
cancel
метод отмены заявки [default - default method, disabled - disabled canceled]
pay_type
способ оплаты [default, disabled, form, myaction, mypaid, coupon, address, link]
pay_link
данные платежной ссылки
cancel_bid
установить статус заявки "отменена пользователем"
/api/v1/cancel_bid/
post-параметры
результат
error_text
описание ошибки
status
новый статус заявки
markpay_bid
установить статус заявки на "отмечено оплачено"
/api/v1/markpay_bid/
post-параметры
результат
error_text
описание ошибки
status
новый статус заявки
success_bid
установить статус заявки на "выполнена"
/api/v1/success_bid/
post-параметры
результат
error_text
описание ошибки
status
новый статус заявки
get_exchanges
получить обмены
/api/v1/get_exchanges/
post-параметры
start_time
время начала unix
end_time
время окончания unix
status_history
показать историю статусов
limit
количество выводимых (max: 250)
результат
error_text
описание ошибки
psys_give
платежная система Отдаю
psys_get
платежная система Получаю
currency_code_give
код валюты Отдаю
currency_code_get
код валюты Получаю
currency_give
валюта Отдаю
currency_get
валюта Получаю
currency_give_id
id валюты Отдаю
currency_get_id
id валюты Получаю
user_hash
хэш пользователя
statuses
история статусов
get_all_exchanges
получить все обмены
/api/v1/get_all_exchanges/
post-параметры
start_time
время начала unix
end_time
время окончания unix
limit
количество выводимых (max: 250)
результат
error_text
описание ошибки
get_partner_info
получить информацию о партнерской программе
/api/v1/get_partner_info/
результат
error_text
описание ошибки
balance
партнерский баланс
min_payout
минимальная сумма для выплаты
items
список платежных систем для выплаты
amount
сумма в этой платежной системе
get_partner_links
получить партнерские переходы
/api/v1/get_partner_links/
post-параметры
start_time
время начала unix
end_time
время окончания unix
limit
количество выводимых (max: 250)
результат
error_text
описание ошибки
user_hash
хэш пользователя
query_string
строка запроса
get_partner_exchanges
получить партнерские обмены
/api/v1/get_partner_exchanges/
post-параметры
start_time
время начала unix
end_time
время окончания unix
status_history
показать историю статусов
limit
количество выводимых (max: 250)
результат
error_text
описание ошибки
psys_give
платежная система Отдаю
psys_get
платежная система Получаю
currency_code_give
код валюты Отдаю
currency_code_get
код валюты Получаю
currency_give
валюта Отдаю
currency_get
валюта Получаю
currency_give_id
id валюты Отдаю
currency_get_id
id валюты Получаю
user_hash
хэш пользователя
accrued
статус начисления
partner_reward
партнерское вознаграждение
get_partner_payouts
получить партнерские выплаты
/api/v1/get_partner_payouts/
post-параметры
start_time
время начала unix
end_time
время окончания unix
limit
количество выводимых (max: 250)
результат
error_text
описание ошибки
method_id
id метода выплаты
pay_currency_code
код валюты выплаты
original_amount
оригинальная сумма
original_currency_code
оригинальный код валюты
add_partner_payout
запрос на выплату партнерских средств
/api/v1/add_partner_payout/
post-параметры
method_id
id метода выплаты
результат
error_text
описание ошибки