Доступ к API

API (Application Programming Interface) - это набор компонентов, описывающих способы взаимодействия одной компьютерной программы (бота, сайта и др.) с другими программами.

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

Чтобы начать работать с платформой, используя API, необходимо:

Создание доступа в API

Чтобы создать доступ в API:

  1. Перейдите в Панели управления в раздел Лицевой счёт → Доступ на вкладку API.

  2. Нажмите кнопку Создать пользователя.

  3. Введите описание пользователя, которое поможет отличать этого пользователя от других, и нажмите Создать.

  4. Откроется окно с указанием сгенерированного уникального пароля.

Warning

ВАЖНО! Обязательно сохраните пароль, после закрытия окна его будет невозможно снова посмотреть или изменить!

  1. Нажмите кнопку Я сохранил. Запись о новом пользователе, в том числе — его логин и автор, появятся в таблице.

Нажмите на строку пользователя, чтобы посмотреть его описание и скачать RC файлы.

Hint

Все пользователи Панели управления, которые имеют доступ к лицевому счету, могут просматривать список пользователей и создавать новых.

Можно создать до 10 пользователей API.

Удаление пользователя API

Для безопасности и сохранения истории пользования полностью удалить пользователя API нельзя, но можно отозвать доступ.

Warning

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

Чтобы отозвать пользователя API:

  1. Перейдите в раздел Лицевой счёт → Доступ на вкладку API.

  2. Нажмите на строку нужного пользователя, и в раскрывшемся меню нажмите кнопку Отозвать.

Статус пользователя будет изменен на Отозван. В описании пользователя появятся дата отзыва доступа и логин пользователя, совершившего это действие.

Выполнение операций в API

Для выполнения операций над инфраструктурой ProCloud воспользуйтесь документацией Openstack и документацией Terraform provider Openstack.