Перейти к содержимому
Последнее обновление

Справочник API

Обзор

Vilna API - это комплексная платформа для управления и мониторинга блокчейн-кошельков, предоставляющая инфраструктуру корпоративного уровня для операций с цифровыми активами.

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

  • Мониторинг транзакций: Отслеживание транзакций блокчейна в реальном времени на множестве сетей
  • Обнаружение токенов: Автоматическое обнаружение и отслеживание токенов
  • Управление адресами: Генерация и управление блокчейн-адресами с поддержкой xpub
  • Запросы балансов: Запрос текущих балансов по адресам
  • Система уведомлений: Webhook и email каналы для событий блокчейна
  • Мультичейн поддержка: 30+ блокчейнов, включая Bitcoin, Ethereum, Solana и другие

Основные концепции

Стандарты идентификации

Vilna реализует стандарты CAIP для единообразной кросс-чейн идентификации:

  • CAIP-2: Идентификация блокчейнов
  • CAIP-10: Идентификация аккаунтов
  • CAIP-19: Идентификация активов

Соглашения об именовании

  • Внутренние ID: Формат UUID v7 для объектов Vilna (например, channel_id, xpub_id)
  • Глобальные ID (GID): Формат CAIP для блокчейн-объектов (например, asset_gid, transaction_gid)

Безопасность

Узнайте о безопасности API:

  • Методы аутентификации
  • Цифровые подписи и верификация webhook
  • Ограничение частоты запросов
  • Лучшие практики

Форматы ответов

Успешный ответ

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "active",
  "created_at": "2024-01-15T10:30:00Z"
}

Ответ списка с пагинацией

{
  "items": [...],
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 20,
    "total_pages": 5
  }
}

Ответ с ошибкой (RFC 7807)

Отчеты об ошибках следуют стандарту RFC 7807 с использованием формата application/json.

Структура ответа с ошибкой

{
  "type": "/problems/invalid-request",
  "title": "Invalid Request",
  "status": 400,
  "detail": "The request contains invalid parameters",
  "errors": [
    {
      "field": "xpub_id",
      "message": "Invalid UUID format"
    }
  ]
}

Распространенные ответы об ошибках

  • 400 Bad Request: Недействительные параметры или тело запроса

    • type: /problems/invalid-request
    • Включает ошибки валидации полей в массиве errors

  • 401 Unauthorized: Отсутствует или недействителен API ключ

    • type: /problems/unauthorized

  • 404 Not Found: Ресурс не найден

    • type: /problems/not-found

  • 500 Internal Server Error: Неожиданная ошибка сервера

    • type: /problems/internal-error

Коды состояния HTTP

КодОписание
200Успешно
201Создано
204Нет содержимого
400Неверный запрос
401Не авторизован
403Запрещено
404Не найдено
422Необработанная сущность
429Слишком много запросов
500Внутренняя ошибка сервера

Ресурсы для разработчиков

Дополнительная документация

Поддержка

 
Следующая страница