Через gRPC API

Почта VK WorkSpace предоставляет gRPC API для резервного копирования и восстановления почтового ящика, облака, календарей, профилей пользователей и адресных книг. Чтобы пользоваться возможностями API вы можете воспользоваться готовым клиентом: Резервное копирование через BMWCLIENT. Либо вы можете написать свой клиент, который будет реализовывать методы резервного копирования.

Обычно продукт Средства резервного копирования включается при первичной установке. Чтобы проверить состояние продукта:

1. Откройте веб-интерфейс установщика http://server-address:8888.

2. Нажмите на кнопку в правом верхнем углу, выберите пункт Продукты.

3. Перейдите на вкладку Администрирование.

4. Продукт Средства резервного копирования должен быть включен:

   

Если продукт выключен, то выполните следующие действия:

1. Включите продукт Средства резервного копирования.
2. Нажмите на кнопку Сохранить.
3. Перейдите на главную страницу установщика.
4. В случае установки Почты на 1 ВМ, можно сгенерировать контейнеры автоматически и запустить автоматическую установку. Если у вас кластерная Почта, то добавьте контейнеры вручную.
5. Если зеленая кнопка Далее в правом верхнем углу отображается и активна, то донастройте параметры системы. Логика: «Следуем за кнопкой Далее то тех пор, пока она активна».
6. Когда зеленая кнопка Далее перестанет отображаться в верхнем углу страницы, можно запускать установку.

Чтобы выполнять запросы к API резервного копирования, нужно добавить перечень IP и подсетей в веб-интерфейсе установщика:

1. Откройте веб-интерфейс установщика http://server-address:8888.

2. Перейдите на вкладку Настройки → Настройки компонентов → Ограничение доступа к доменам.

   

3. Затем кликните по домену bmw.server-adress и нажмите кнопку редактировать .

4. Включите опцию Ограничить доступ к домену.

5. Добавьте IP и подсети, под которыми разрешено обращаться к API резервного копирования. Чтобы разрешить всем IP и подсетям обращаться к API резервного копирования, добавьте IP-адрес 0.0.0.0/0. По умолчанию доступ к домену bmw.server-adress запрещен всем IP/подсетям.

   

6. Кликните по кнопке Сохранить.

7. Перейдите к списку машин и включите опцию «Не показывать завершенные».

8. Запустите следующие шаги:

   

Запросы к API резервного копирования можно будет выполнять, исходя из настроек IP и подсетей.

1. Перейдите на страницу biz.<сompany_domain> и авторизуйтесь в панели администратора.

2. Перейдите по URL-адресу https://biz.<mail_domain>/oper/

3. В меню слева выберите пункт Токены, на странице нажмите Добавить.

   

4. В окне добавления токена укажите дату истечения действия токена (согласно вашим внутренним политикам компании), а также комментарий.

   

5. Нажмите Добавить. Отобразится окно со сгенерированным токеном.

Чтобы проверить доступность API резервного копирования рекомендуем выполнить запрос с помощью утилиты grpcurl.

Например, запросить список пользователей домена:

 
grpcurl -d '{"domain":"wm1.onprem.ru", "token": "1opM9wAORbSYr3uzut997i"}' \bmw.wm1.on-premise.ru:443 backupserver.BackupMailbox/Users

Пример ответа:

 
{  "user": [    {      "Email": "user1@wm1.onprem.ru",      "RealName": "user"    }  ]}{  "user": [    {      "Email": "user2@wm1.onprem.ru",      "RealName": "user2"    }  ]}

Чтобы разработать свой клиент для резервного копирования Почты VK WorkSpace вам понадобятся proto-файлов, в которых находится описание методов и полей, которые необходимо передавать при вызове метода.

Чтобы скачать архив со всеми proto-файлами, перейдите по адресу:biz.<your_domain>/bmw/api/v1/download/client/proto.