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

API ArchiVision

Этот раздел предназначен для разработчиков интеграций. Здесь собраны технические сведения о чтении и обновлении архитектурной модели из внешних систем. Пользовательские инструкции по работе в интерфейсе находятся отдельно — в руководстве по ArchiVision.

Загрузка изображения...
Учебная API-консоль показывает выбранные организацию, ландшафт и домен перед чтением или изменением архитектурной модели.

Что можно автоматизировать​

Integration API подходит для следующих сценариев:

  • первичная загрузка организаций, ландшафтов, доменов и элементов;
  • синхронизация с CMDB и каталогами сервисов;
  • обновление свойств архитектурных объектов;
  • создание диаграмм и их состава;
  • чтение модели для внешних отчётов;
  • загрузка и актуализация интерфейсов;
  • интеграция с AI- и MCP-инструментами.

С чего начать​

  1. Прочитайте справочник Integration API.
  2. Определите организацию, ландшафт, домен и рабочую ветку для запросов.
  3. Проверьте права технического или пользовательского аккаунта.
  4. Для массового изменения создайте отдельную рабочую ветку.
  5. После загрузки проверьте историю действий, дашборды и выполните слияние.

API и интерфейсы в архитектурной модели​

Не путайте два связанных понятия:

  • Integration API позволяет внешней системе читать и изменять модель ArchiVision.
  • Раздел «API и интерфейсы на диаграммах» объясняет, как пользователь описывает endpoint-ы и связывает их с элементами и шагами потоков внутри самой модели.

Эти возможности дополняют друг друга: интеграция может загрузить интерфейсы, а аналитик — проверить и связать их с пользовательскими сценариями.

Безопасная работа​

  • Используйте минимально необходимые права.
  • Не выполняйте массовые изменения непосредственно в защищённой master-ветке.
  • Перед повторной загрузкой проверяйте существующие объекты, чтобы не создавать дубли.
  • Учитывайте блокировку ветки во время процесса слияния.
  • Проверяйте результат автоматизации в интерфейсе и командной истории.

Перейти к полной технической справке: Integration API.