Разработка · Официальная документация

API для разработчиков

В настоящее время публичный API недоступен. Эта страница описывает планируемую основу API только для чтения, не раскрывая RPC узлов.

Доступность

Принципы проектирования

  • Публичный доступ только для чтения к публичным данным блокчейна.
  • Никаких операций записи, подписи или управления кошельком.
  • Никакого прямого раскрытия RPC узла.
  • Кэширование ответов и ограничение скорости для защиты инфраструктуры.
  • Недоступность API не влияет на просмотр сайта.
  • Документирование схем, кодов ошибок и ограничений перед вводом в эксплуатацию.

Запланированные ресурсы

Состояние службы
Доступность API, публичная высота цепи и общая информация о сети.
Блоки
Постраничный список блоков и просмотр блока по высоте или публичному идентификатору.
Транзакции
Просмотр публичной транзакции по её идентификатору.
Адреса
Публичная история адреса без каких-либо приватных данных кошелька.
Сеть
Публичная информация о узлах и состоянии синхронизации, агрегированная и нечувствительная.

Пути, форматы ответов, параметры пагинации и ограничения скорости будут зафиксированы в версионированной спецификации, опубликованной до открытия API.

Интеграция на сайте

Сайт спроектирован так, чтобы оставаться автономным. Любая будущая интеграция будет проходить через выделенный серверный слой доступа с тайм-аутом, проверкой ответов и явным состоянием недоступности.

  • В рабочей среде не должно отображаться никаких демонстрационных данных.
  • Недоступный ответ должен приводить к чётко обозначенному пустому состоянию.
  • Ошибки API не должны раскрывать информацию об инфраструктуре.
  • Сайт никогда не должен зависеть от API для отображения своих статических страниц.