Использование REST API надстроек Microsoft Edge

Статья
03/12/2024

API надстроек Microsoft Edge предоставляет набор конечных точек REST для программной публикации обновлений надстроек, отправленных в хранилище надстроек Microsoft Edge. Эти конечные точки REST можно использовать для автоматизации процесса отправки и публикации новых версий надстроек в хранилище надстроек Microsoft Edge. Для работы с этими конечными точками вы будете использовать страницу Публикация API в Центре партнеров.

Чтобы отправить предложения и отзывы, введите вопрос об API надстроек.

Терминология

Термин	Определение
operation	Операция REST, например GET или PUT.
идентификатор операции	Идентификатор операции REST.
package	Пакет `.zip` , содержащий файлы для надстройки Microsoft Edge.
Продукта	Расширение или тема Microsoft Edge. Также называется надстройкой Microsoft Edge.
идентификатор продукта	Идентификатор продукта, черновик которого должен быть опубликован. Идентификатор продукта — это 128-разрядный GUID, связанный с продуктом в Центре партнеров. Пример: `d34f98f5-f9b7-42b1-bebb-98707202b21d`.
Представления	Обновление, которое отправляется в существующий продукт в Центре партнеров. Каждое обновление продукта является отправкой, независимо от того, является `In Draft`ли состояние , `In Review`или `In the Store` (опубликовано).

Перед началом работы

Чтобы использовать API надстроек Microsoft Edge, необходимо включить API для проекта в Центре партнеров Майкрософт, создав учетные данные API. Чтобы создать учетные данные API, выполните следующие действия.

Перейдите в Центр партнеров Майкрософт и войдите в учетную запись, используемую для публикации надстройки.
В программе Microsoft Edge выберите Опубликовать API.
На странице Публикация API нажмите кнопку Создать учетные данные API . Выполнение этого шага может занять несколько минут.

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

Важно!

Обязательно запишите секрет клиента сейчас, так как он отображается только сразу после включения или продления API (т. е. после создания учетных данных API). Этот секрет больше не отображается.

Для идентификатора клиента можно создать несколько секретов клиента. Например, можно создать несколько секретов для нескольких проектов.

Получение маркера доступа

Получив необходимую авторизацию для приложения, получите маркеры доступа для API. Чтобы получить маркер с помощью предоставленных учетных данных клиента, отправьте запрос POST на URL-адрес маркера доступа (маркер OAuth). Сведения о клиенте доступны в URL-адресе, полученном в разделе Перед началом работы выше.

Endpoint: https://login.microsoftonline.com/5c9eedce-81bc-42f3-8823-48ba6258b391/oauth2/v2.0/token
Type: POST
Header Parameters: Content-Type: application/x-www-form-urlencoded

Пример запроса

> curl \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "client_id={$Client_ID}" \
-d "scope=https://api.addons.microsoftedge.microsoft.com/.default" \
-d "client_secret={$Client_Secret}" \
-d "grant_type=client_credentials" \
-v \
https://login.microsoftonline.com/5c9eedce-81bc-42f3-8823-48ba6258b391/oauth2/v2.0/token

Пример отклика

{
  "token_type": "Bearer",
  "expires_in": 3599,
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1uQ19WWmNBVGZNNXBP..."
}

Дополнительные сведения см. в разделе Поток учетных данных клиента OAuth 2.0 на платформа удостоверений Майкрософт.

Использование конечных точек API

После получения маркера доступа можно использовать API надстроек Microsoft Edge. Этот API предоставляет конечные точки для получения списка продуктов, обновления продуктов и публикации продуктов.

Примечание.

API для создания нового продукта или обновления метаданных продукта не существует. Например, описание. Эти задачи необходимо выполнить вручную в Центре партнеров Майкрософт.

API доступен в конечной точке https://api.addons.microsoftedge.microsoft.com

Отправка пакета для обновления существующей отправки

Используйте этот API для обновления пакета надстройки. Этот API отправляет пакет для обновления существующей отправки черновика надстройки.

Endpoint: /v1/products/$productID/submissions/draft/package
Type: POST
Header Parameters: Authorization: Bearer $TOKEN; Content-Type: application/zip
Body content: the package file to upload

$productID — это идентификатор продукта надстройки Microsoft Edge, которую требуется обновить.

Чтобы получить идентификатор продукта, выполните следующие действия:

Войдите в Центр партнеров Майкрософт.
Перейдите в раздел Обзор Microsoft Edge>.
Выберите расширение, для которого требуется идентификатор продукта.

Откроется страница Обзор расширения . Идентификатор продукта отображается на странице. (Идентификатор продукта также отображается в качестве GUID в URL-адресе в адресной строке между microsoftedge/ и /packages.)
В разделе Удостоверение расширения (или в адресной строке) выберите и скопируйте идентификатор продукта.

Пример запроса

> curl \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/zip" \
-X POST \
-T $FILE_NAME \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/draft/package

Если запрос выполнен успешно и процесс обновления начинается, вы получите 202 Accepted код состояния ответа с заголовком Location . Этот заголовок расположения содержит operationID объект , необходимый для проверки состояния операции обновления.

См. также:

Справочник по API: отправка пакета для обновления существующей отправки

Проверка состояния отправки пакета

Используйте этот API для проверка состояния отправки пакета.

Endpoint: /v1/products/$productID/submissions/draft/package/operations/$operationID
Type: GET
Header Parameters: Authorization: Bearer $TOKEN

Пример запроса

> curl \
-H "Authorization: Bearer $TOKEN" \
-X GET \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/draft/package/operations/$operationID

См. также:

Справочник по API: проверка состояния отправки пакета

Публикация отправки

Используйте этот API для публикации текущего проекта продукта на веб-сайте надстроек Microsoft Edge.

Endpoint: /v1/products/$productID/submissions
Type: POST
Header Parameters: Authorization: Bearer $TOKEN
Body content: Notes for certification, in JSON format

Пример запроса

> curl \
-H "Authorization: Bearer $TOKEN" \
-X POST \
-d '{ "notes"="text value" }' \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions

Если запрос завершается успешно и начинается процесс публикации, вы получите 202 Accepted код состояния ответа с заголовком Location . Этот заголовок расположения содержит operationID объект , необходимый для проверки состояния операции публикации.

См. также:

Справочник по API: публикация отправки черновика продукта

Проверка состояния публикации

Используйте этот API для проверка состояния операции публикации.

Endpoint: /v1/products/$productID/submissions/operations/$operationID
Type: GET
Header Parameters: Authorization: Bearer $TOKEN

Пример запроса

> curl \
-H "Authorization: Bearer $TOKEN" \
-X GET \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/operations/{operationID}

См. также:

Использование REST API надстроек Microsoft Edge: проверка состояния публикации

Использование REST API надстроек Microsoft Edge

Терминология

Перед началом работы

Получение маркера доступа

Пример запроса

Пример отклика

Использование конечных точек API

Отправка пакета для обновления существующей отправки

Пример запроса

Проверка состояния отправки пакета

Пример запроса

Публикация отправки

Пример запроса

Проверка состояния публикации

Пример запроса

Дополнительные ресурсы