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

Руководство по Management API

Management API позволяет управлять рабочими пространствами, участниками команды, проектами и ключами API программно. Используйте его для автоматизации онбординга, ротации учётных данных и управления доступом в вашей организации.

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

Все запросы требуют ключ управления (префикс vilna_mgt_) в заголовке X-Api-Key:

export VILNA_MGT_KEY="vilna_mgt_..."

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

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

Типы ключей API

ТипПрефиксОбластьНазначение
Ключ APIvilna_api_ПроектДоступ к Platform API (адреса, транзакции, балансы)
Ключ RPCvilna_rpc_Рабочее пространствоПодключение к блокчейн-эндпоинтам RPC
Ключ управленияvilna_mgt_Рабочее пространствоУправление рабочими пространствами, участниками, проектами и ключами

Создание проекта

Каждый проект получает собственные ключи API и отслеживаемые адреса.

curl -X POST "https://mgmt.vilna.app/workspaces/{workspace_id}/projects" \
  -H "X-Api-Key: ${VILNA_MGT_KEY}" -H "Content-Type: application/json" \
  -d '{"name": "Production", "slug": "production"}'

Приглашение участника команды

Поддерживаемые роли для приглашения: admin (управляет участниками, проектами, ключами) и member (только чтение, требуется явное назначение проекта).

curl -X POST "https://mgmt.vilna.app/workspaces/{workspace_id}/invitations" \
  -H "X-Api-Key: ${VILNA_MGT_KEY}" -H "Content-Type: application/json" \
  -d '{"email": "colleague@example.com", "role": "admin"}'

Отзовите ожидающие приглашения с помощью POST .../invitations/{invitation_id}/actions/revoke.

Создание и ротация ключей API

Сам ключ возвращается один раз при создании -- сохраните его в надёжном месте.

curl -X POST "https://mgmt.vilna.app/workspaces/{workspace_id}/projects/{project_id}/api-keys" \
  -H "X-Api-Key: ${VILNA_MGT_KEY}" -H "Content-Type: application/json" \
  -d '{"name": "Backend Service Key", "permissions": ["api:address:read", "api:transaction:read", "api:balance:read"]}'

Чтобы выполнить ротацию ключа, создайте новый, обновите ваше приложение, затем отзовите старый ключ с помощью POST .../api-keys/{key_id}/actions/revoke.

Следующие шаги

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