API Swapoon
Публичные точки доступа для активов и курсов, а также партнёрский API с аутентификацией.
Введение
API Swapoon состоит из двух частей. Публичные точки доступа работают только на чтение и не требуют аутентификации — они возвращают список поддерживаемых активов и текущие курсы. Партнёрский API использует аутентификацию по ключу и позволяет создавать реальные обмены, которые автоматически засчитываются на ваш партнёрский счёт. Все точки доступа расположены по базовому URL, указанному ниже, и возвращают JSON.
Формат ответа
Публичные точки доступа помещают данные в оболочку success/data. Партнёрский API возвращает плоский объект с булевым полем ok и соответствующими полями на верхнем уровне.
Публичные точки доступа
Список поддерживаемых активов с лимитами и знаками после запятой.
Текущие обменные курсы (из кеша). Базовый актив — XMR.
Партнёрский API
Обзор
Партнёрский API позволяет встроить Swapoon в ваш сайт или приложение. Каждый созданный через него обмен автоматически засчитывается на ваш партнёрский счёт: вы получаете 0.5 % от объёма каждого завершённого обмена, выплаты производятся вручную в Monero. Создайте ключ API в партнёрском кабинете.
Аутентификация
Передавайте секретный ключ в виде токена Bearer при каждом запросе. Храните его в тайне — он позволяет создавать реальные обмены. При утечке отзовите и перевыпустите ключ в кабинете (прежний ключ перестаёт работать немедленно).
На сервере хранится только хеш ключа. Полный ключ показывается один раз, при создании.
Поддерживаемые токены с их ключами, символами, сетями и знаками после запятой.
Расчёт для пары. Параметры запроса: from, to (ключи токенов из /coins), amount (в обычных единицах).
Создать реальный обмен, засчитываемый на ваш счёт. Тело запроса (JSON): from, to, amount, to_address и необязательный refund_address. Отправьте депозит на возвращённый адрес.
Создаёт реальную транзакцию с реальными средствами. Внимательно проверьте to_address — обмены необратимы.
Статус одного из ваших обменов. Видны только обмены, созданные с вашим ключом.
Статусы: awaiting_deposit, deposit_detected,
deposit_confirmed, exchanging, sending,
completed, expired, refunded.
История ваших обменов с постраничной разбивкой. Параметр запроса: per_page (от 1 до 50, по умолчанию 20).
Ваши партнёрские итоги: клики, обмены, объём, заработано и ожидает выплаты.
Ошибки
Ошибки используют стандартные коды состояния HTTP с телом ok: false.
401 | Ключ API отсутствует или недействителен. |
404 | Обмен не найден (или принадлежит не вам). |
422 | Неверные параметры, неизвестный токен или сумма вне допустимых пределов. |
429 | Превышен лимит запросов. |
Лимиты запросов
Публичные точки доступа: 120 запросов в минуту с одного IP. Партнёрские запросы на чтение: 120 в минуту на ключ. Создание обмена (POST /swaps): 10 в минуту на ключ, поскольку операция затрагивает реальные средства. При превышении возвращается 429.