API#

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

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

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

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

  1. Чтобы создать доступ в API перейдите в Панели управления в раздел “Профиль пользователя” в верхнем правом углу или в вертикальном меню слева страницы.

  2. В разделе “Доступ в API” нажмите на кнопку “Создать доступ”, откроется раздел “Создание доступа”.

  3. Задайте пароль пользователя API и повторите его в соседнем окне или воспользуйтесь функцией генерации пароля.

  4. Нажмите на кнопку “Создайте доступ”.

  5. Автоматически будет сгенерирован логин пользователя API.

Изменение пароля пользователя API#

  1. Чтобы изменить пароль пользователя API перейдите в Панели управления в раздел “Профиль пользователя” в верхнем правом углу или в вертикальном меню слева страницы.

  2. В разделе “Доступ в API” нажмите на кнопку “Изменить пароль”, откроется раздел “Изменение пароля”.

  3. Введите и повторите новый пароль или воспользуйтесь функцией генерации нового пароля.

  4. Нажмите на кнопку “Изменить пароль”.

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

  1. Чтобы удалит пользователя API перейдите в Панели управления в раздел “Профиль пользователя” в верхнем правом углу или в вертикальном меню слева страницы.

  2. В разделе “Доступ в API” нажмите на кнопку “Удалить”. После удаления пользователя API доступ к API будет так же удален.

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

Для выполнения операций над инфраструктурой ProCloud воспользоваться документацией https://docs.openstack.org/api-quick-start/ и https://registry.terraform.io/providers/terraform-provider-openstack/openstack/latest/docs.