API

Получение API ключей через личный кабинет

Пользователь может получить доступ к API через свой личный кабинет:
Раздел API для пользователей.

После выбора методов и указания IP-адресов, пользователь должен нажать кнопку "Добавить API ключ". На странице отобразится сгенерированная пара Логин — Ключ. Для одного пользователя можно выпустить несколько ключей с разными наборами методов.

Использование API

Точка входа:
https://alwaysmoney.org/api/userapi/v1/ + метод API

Для авторизации необходимо включить следующие заголовки с информацией, полученной в разделе "API":

• API-LOGIN — Логин API
• API-KEY — Ключ API
• API-LANG — Принудительное использование указанного языка (необязательно). Пример: ru_RU, en_US.

Все запросы отправляются с использованием метода POST, и ответ возвращается в формате JSON. GET запросы не используются, параметры передаются в теле запроса.

Методы работы с API:

• test

Тестовый метод для проверки функциональности API.

Параметры запроса:
---

Ответ:
ip - ваш IP-адрес
user_id - ID пользователя (если система делает запрос, ID = 0)
locale - язык сайта
partner_id - ID партнера


• get_direction_currencies

Получить список валют, доступных для обмена.

Параметры запроса:
currency_id_give - ID валюты "Отдаю" (фильтр, необязательный параметр)
currency_id_get - ID валюты "Получаю" (фильтр, необязательный параметр)

Ответ:
Ответ содержит 2 списка:
give - список валют "Отдаю"
get - список валют "Получаю"
Каждый список включает следующие данные:
id - ID валюты в обмене
title - название валюты в обмене
logo - ссылка на логотип валюты


• get_directions

Получить список направлений обмена, доступных для обмена.

Параметры запроса:
currency_id_give - ID валюты "Отдаю" (фильтр, необязательный параметр)
currency_id_get - ID валюты "Получаю" (фильтр, необязательный параметр)

Ответ:
Ответ содержит список направлений обмена, где:
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

Получить информацию о направлении обмена.

Параметры запроса:
direction_id - ID направления обмена

Ответ:
id — ID направления обмена
url — ссылка на страницу обмена
currency_code_give — код валюты "Отдаю"
currency_code_get — код валюты "Получаю"
reserve — резерв суммы
course_give — курс валюты "Отдаю"
course_get — курс валюты "Получаю"
sum_give — сумма в валюте "Отдаю"
sum_give_com — сумма в валюте "Отдаю" с комиссией
sum_get — сумма в валюте "Получаю"
sum_get_com — сумма в валюте "Получаю" с комиссией
com_give — текст комиссии для валюты "Отдаю"
com_get — текст комиссии для валюты "Получаю"
min_give — минимальная сумма для валюты "Отдаю", если не установлено - "нет"
max_give — максимальная сумма для валюты "Отдаю", если не установлено - "нет"
min_get — минимальная сумма для валюты "Получаю", если не установлено - "нет"
max_get — максимальная сумма для валюты "Получаю", если не установлено - "нет"
info
timeline_text — описание обмена
frozen_text — текст для замороженного статуса
before_button_text — текст перед кнопкой "Оплатить"
give_fields — список полей для валюты "Отдаю"
get_fields — список полей для валюты "Получаю"
dir_fields — список полей для направления обмена
Описание полей:
name — название поля для передачи
type — тип поля
label — описание поля
req — 0 - необязательно, 1 - обязательно
tooltip — текст подсказки
options — возможные варианты, если поле типа "выбор"
cd — указатель на дополнительные параметры


• get_calc

Калькулятор для расчета суммы по направлению обмена.

Параметры запроса:
direction_id — ID направления обмена
calc_amount — сумма
calc_action — тип суммы:
1 — сумма в валюте "Отдаю"
2 — сумма в валюте "Получаю"
3 — сумма в валюте "Отдаю" с комиссией
4 — сумма в валюте "Получаю" с комиссией
cd — поля направления обмена, помеченные cd = 1, в одном поле. Поле кодируется в URL.


Ответ:
currency_code_give — код валюты "Отдаю"
currency_code_get — код валюты "Получаю"
reserve — резерв валюты "Получаю"
course_give — курс валюты "Отдаю"
course_get — курс валюты "Получаю"
sum_give — сумма в валюте "Отдаю"
sum_give_com — сумма в валюте "Отдаю" с комиссией
sum_get — сумма в валюте "Получаю"
sum_get_com — сумма в валюте "Получаю" с комиссией
com_give — текст комиссии для валюты "Отдаю"
com_get — текст комиссии для валюты "Получаю"
min_give — минимальная сумма для валюты "Отдаю", если не установлено - "нет"
max_give — максимальная сумма для валюты "Отдаю", если не установлено - "нет"
min_get — минимальная сумма для валюты "Получаю", если не установлено - "нет"
max_get — максимальная сумма для валюты "Получаю", если не установлено - "нет"
changed — флаг изменения введенной суммы: 0 - изменение не требуется, 1 - требуется изменить


• get_exchanges

Вывод заявок, созданных с этим ключом.

Параметры запроса:
start_time — время начала в формате Unix (фильтр, необязательный параметр)
end_time — время окончания в формате Unix (фильтр, необязательный параметр)
ip — IP-адрес (фильтр, необязательный параметр)
id — ID заявки (фильтр, необязательный параметр)
api_id — ID, переданный в API (фильтр, необязательный параметр)
status_history — отображать историю статусов: 0 - нет, 1 - да (фильтр, необязательный параметр)
limit — количество отображаемых заявок (фильтр, необязательный параметр)
offset — сколько заявок пропустить (фильтр, необязательный параметр)


Ответ:
items — список заявок
id — ID заявка
api_id — ID, переданный в API
time — время изменения статуса
date — дата изменения статуса
psys_give — платежная система для валюты "Отдаю"
psys_get — платежная система для валюты "Получаю"
currency_code_give — код валюты "Отдаю"
currency_code_get — код валюты "Получаю"
course_give — курс валюты "Отдаю"
course_get — курс валюты "Получаю"
amount_give — сумма в валюте "Отдаю"
amount_get — сумма в валюте "Получаю"
exchange_success — 0 - заявка выполнен, 1 - заявка не выполнен
user_hash — хеш пользователя
user_ip — IP-адрес пользователя
status — статус заявка
statuses — список изменений статуса:
time — время изменения статуса
date — дата изменения статуса
status — статус заявка


• create_bid

Создание заявки.

Параметры запроса:
direction_id — ID направления обмена
partner_id — ID партнера (необязательный параметр)
api_id — ID заявки в вашей системе (необязательный параметр)
calc_amount — сумма обмена
calc_action — тип суммы:
1 — сумма в валюте "Отдаю",
2 — сумма в валюте "Получаю",
3 — сумма в валюте "Отдаю" с комиссией,
4 — сумма в валюте "Получаю" с комиссией
callback_url — URL для обратного вызова при изменении статуса заявки.
account1 — счет отправителя
cfgive8 — имя владельца карты
account2 — счет получателя
cfgive3 — адрес возврата
cf1-99 — пользовательские поля
Пример:
cf1 — Имя
cf2 — Отчество
cf3 — Фамилия
cf4 — Номер телефона
cf6 — E-mail
cf11 — Telegram


Ответ:
url — ссылка на страницу обмена
id — ID заявки
hash — хеш заявки
status — статус заявки
status_title — название статуса заявки
psys_give — платежная система для валюты "Отдаю"
psys_get — платежная система для валюты "Получаю"
currency_code_give — код валюты "Отдаю"
currency_code_get — код валюты "Получаю"
amount_give — сумма в валюте "Отдаю"
amount_get — сумма в валюте "Получаю"
api_actions — доступные действия
type — тип платежа
cancel — метод отмены заявки
instruction — инструкция по оплате
pay_amount — сумма к оплате


• cancel_bid

Отмена заявки (метод работает только в том случае, если ответ на create_bid включает api_actions -> cancel = ‘api’).

Параметры запроса:
hash — хеш заявки

Ответ:
статус заявки

• pay_bid

Отметить заявку как оплаченный (метод работает только в том случае, если ответ на create_bid включает api_actions -> pay = ‘api’).

Параметры запроса:
hash — хеш заявки

Ответ:
статус заявки

• bid_info

Информация по оплате заявки.

Параметры запроса:
id — ID заявки(необязательно, если указан хеш)
hash — хеш заявки(необязательно, если указан ID)

Ответ:
url — ссылка на страницу обмена
id — ID заявки
hash — хеш заявки
status — статус
status_title — название статуса
psys_give — платежная система для валюты "Отдаю"
psys_get — платежная система для валюты "Получаю"
currency_code_give — код валюты "Отдаю"
currency_code_get — код валюты "Получаю"
amount_give — сумма в валюте "Отдаю"
amount_get — сумма в валюте "Получаю"
api_actions — доступные действия
type — тип платежа
cancel — метод отмены заявки
instruction — инструкция по оплате
pay_amount — сумма к оплате


• get_partner_info

Информация о партнере.

Параметры запроса:
---

Ответ:
partner_id — ID партнера
balance — баланс
min_payout — минимальная сумма для вывода
items — список валют для вывода:
id — ID валюты
title — название валюты
commission — комиссия
amount — баланс в данной валюте


• get_partner_links

Информация о партнерских ссылках.

Параметры запроса:
start_time — время начала в формате Unix (фильтр, необязательный параметр)
end_time — время окончания в формате Unix (фильтр, необязательный параметр)
ip — IP-адрес (фильтр, необязательный параметр)
limit — количество отображаемых записей (фильтр, необязательный параметр)


Ответ:
items — список партнерских ссылок:
time — время перехода
date — дата перехода
browser — браузер
ip — IP-адрес пользователя, совершившего переход
referrer — страница, с которой был сделан переход
user_hash — хеш пользователя
query_string — строка запроса


• get_partner_exchanges

Информация о партнерских обменах.

Параметры запроса:
start_time — время начала в формате Unix (фильтр, необязательный параметр)
end_time — время окончания в формате Unix (фильтр, необязательный параметр)
ip — IP-адрес (фильтр, необязательный параметр)
id — ID заявки(фильтр, необязательный параметр)
status_history — отображать историю статусов: 0 - нет, 1 - да (фильтр, необязательный параметр)
limit — количество отображаемых заявок (фильтр, необязательный параметр)


Ответ:
items — список заявок:
id — ID заявки
time — время изменения статуса
date — дата изменения статуса
psys_give — платежная система для валюты "Отдаю"
psys_get — платежная система для валюты "Получаю"
currency_code_give — код валюты "Отдаю"
currency_code_get — код валюты "Получаю"
course_give — курс валюты "Отдаю"
course_get — курс валюты "Получаю"
amount_give — сумма в валюте "Отдаю"
amount_get — сумма в валюте "Получаю"
exchange_success — 0 - заявка выполнен, 1 - заявка не выполнен
accrued — 0 - вознаграждение не начислено, 1 - вознаграждение начислено
partner_reward — вознаграждение партнера
user_hash — хеш пользователя
user_ip — IP-адрес пользователя
status — статус заявки
statuses — список изменений статуса:
time — время изменения статуса
date — дата изменения статуса
status — статус заявки


• get_partner_payouts

Список запросов на вывод средств от пользователей.

Параметры запроса:
start_time — время начала в формате Unix (фильтр, необязательный параметр)
end_time — время окончания в формате Unix (фильтр, необязательный параметр)
limit — количество отображаемых записей (фильтр, необязательный параметр)
id — ID запроса (фильтр, необязательный параметр)


Ответ:
items — список запросов:
id — ID запроса
time — время выплаты
date — дата выплаты
method_id — валюта выплаты
account — счет для выплаты
pay_amount — сумма выплаты
pay_currency_code — код валюты выплаты
original_amount — исходная сумма выплаты
original_currency_code — исходный код валюты выплаты
status — статус запроса. 0 - ожидается, 1 - выплачено, 2 - отменено


• add_partner_payout

Создание запроса на вывод средств.

Параметры запроса:
method_id — ID валюты выплаты
account — номер счета для выплаты


Ответ:
payout_id — ID выплаты