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

Management API

Обзор

Vilna Management API предоставляет программный доступ к администрированию рабочих пространств, управлению командой и жизненному циклу API-ключей. Базовый URL: https://mgmt.vilna.app. Полная документация эндпоинтов доступна в справочнике Management API.

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

Все запросы требуют management API-ключ в заголовке X-Api-Key:

curl -X GET https://mgmt.vilna.app/workspaces/{workspace_id}/members \
  -H "X-Api-Key: vilna_mgt_..."

Management-ключи имеют префикс vilna_mgt_ и привязаны к рабочему пространству. См. Авторизация для описания ролей и разрешений.

Базовый URL

https://mgmt.vilna.app

Формат запросов

  • Content-Type: application/json
  • Все ресурсы рабочего пространства вложены в /workspaces/{workspace_id}/
  • Пагинация: ?limit=30&page=1 (limit: 1-100, по умолчанию 30)

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

Один элемент:

{
  "item": { ... }
}

Список:

{
  "items": [ ... ],
  "meta": {
    "limit": 30,
    "page": 1,
    "total": 10,
    "total_pages": 1
  }
}

Обработка ошибок

Ошибки соответствуют RFC 7807 Problem Details (Content-Type: application/problem+json). См. Ошибки и устранение неполадок для подробностей.

Иерархия ресурсов

Management API организован вокруг иерархии рабочих пространств:

  • Рабочее пространство — организационная единица верхнего уровня
    • Участники — доступ команды на уровне рабочего пространства
    • Проекты — граница изоляции данных внутри рабочего пространства
      • API-ключи — токены доступа к Platform API (привязаны к проекту)
    • RPC-ключи — токены доступа к RPC-эндпоинтам блокчейнов (привязаны к рабочему пространству)
    • Management-ключи — токены для программного управления (привязаны к рабочему пространству)

Все ресурсы, привязанные к проекту (например, API-ключи), изолированы внутри своего проекта. Ресурсы уровня рабочего пространства (RPC-ключи, management-ключи) действуют в пределах всего рабочего пространства.

Ресурсы API

  • Members — список и удаление участников рабочего пространства
  • Invitations — создание, просмотр и обработка приглашений
  • Projects — создание и управление проектами
  • Project Members — назначение и управление доступом участников к проектам
  • API Keys — ключи для Platform API (привязаны к проекту)
  • RPC Keys — ключи для RPC-эндпоинтов блокчейнов (привязаны к рабочему пространству)
  • Management Keys — ключи для программного управления (привязаны к рабочему пространству)

Полная документация эндпоинтов доступна в справочнике Management API.

Связанные разделы

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