API BitcoinVN — Руководство по интеграции и сценарии использования

    BitcoinVN предоставляет REST API, позволяющий разработчикам интегрировать мгновенный обмен криптовалют в свои приложения. Полная интерактивная документация доступна на bitcoinvn.io/api/doc.

    Начало работы

    1. Получите API-ключ: Зарегистрируйтесь на bitcoinvn.io и создайте API-ключ в личном кабинете (bitcoinvn.io/api-keys)
    2. Изучите эндпоинты: Используйте интерактивный Swagger UI на bitcoinvn.io/api/doc или скачайте OpenAPI-спецификацию на bitcoinvn.io/api/doc.json
    3. Запуск: Создавайте котировки, отправляйте ордера и получайте уведомления через вебхуки

    Аутентификация

    Публичные эндпоинты (курсы, информация об активах, поиск ордеров) не требуют аутентификации. Для приватных эндпоинтов (создание ордеров, балансы, KYC, стейкинг) добавляйте API-ключ в заголовок X-API-KEY к каждому запросу.

    Основной процесс

    1. GET /api/info - Узнайте поддерживаемые активы и методы перевода
    2. POST /api/quotes - Зафиксируйте обменный курс на 15 минут
    3. POST /api/orders - Создайте ордер с ID котировки и данными для расчета
    4. Клиент отправляет депозит на адрес, указанный в ответе ордера
    5. GET /api/orders/{shortId} - Отслеживайте статус ордера или используйте вебхуки

    Сценарии использования

    • Агрегаторы обмена: Добавьте BitcoinVN как провайдера обмена для более чем 100 активов. Используйте публичные эндпоинты курсов и котировок для отображения конкурентных цен, затем отправляйте ордера от имени пользователей.
    • Прием платежей: Принимайте криптовалютные платежи от клиентов по всему миру и получайте расчет в любом поддерживаемом активе.
    • Кошельки и приложения: Встройте функцию обмена прямо в ваш кошелек или приложение с помощью нескольких API-вызовов. Пользователи могут обменивать активы, не покидая ваш интерфейс.
    • Автоматическая торговля: Создавайте ботов, отслеживающих курсы через эндпоинт ticker, и автоматически выполняйте обмены при достижении целевых цен.
    • Учет и отчетность: Используйте эндпоинты баланса и журнала для получения истории транзакций для бухгалтерии, сверки или налоговой отчетности.
    • Инструменты комплаенса: Используйте эндпоинты управления черным списком для проверки криптоадресов или IP-адресов и установки порогов заморозки для отмеченных транзакций.
    • Панель стейкинга: Запрашивайте текущие предложения по стейкингу и управляйте настройками автостейкинга через свой интерфейс.

    Ключевые возможности

    • Более 100 поддерживаемых активов в нескольких сетях
    • Обязывающие котировки с гарантированной ценой на 15 минут
    • Уведомления через вебхуки для отслеживания статуса ордеров в реальном времени
    • Личные данные не требуются для базовых крипто-обменов
    • Спецификация OpenAPI 3.0 для простой генерации клиентского кода

    Поддержка разработчиков

    По вопросам интеграции присоединяйтесь к нашему Telegram-чату для разработчиков или пишите на [email protected].

    Опубликовано