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

Используйте этот REST API для программного обновления расширения, опубликованного на веб-сайте надстроек Microsoft Edge, чтобы автоматизировать процесс отправки и публикации новых версий расширения. Эти конечные точки REST API можно интегрировать непосредственно в конвейер непрерывной интеграции и непрерывной поставки (CI/CD), чтобы публиковать обновления пакетов расширений на веб-сайте надстроек Microsoft Edge без использования Центра партнеров.

Этот REST API предоставляет конечные точки для:

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

Эти конечные точки описаны ниже.

Чтобы использовать этот REST API, сначала используйте страницу Публикация API в Центре партнеров, чтобы включить API.

Для первоначальной публикации нового расширения используется Центр партнеров. Чтобы обновить расширение, вручную используйте Центр партнеров или программно используйте этот REST API.

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

Версии REST API обновления

По состоянию на 6 сентября 2024 г. поддерживаются версии 1.1 и версии 1 этого REST API обновления. Поддержка версии 1 завершится 31 декабря 2024 г.

Используемые компоненты

v1.1

Версия 1.1 использует ключ API. Пользовательский интерфейс в Центре партнеров предоставляет ключи API.

Конечные точки REST используют определенные заголовки запросов для версии 1.1.

версия 1

Версия 1 требует отправки маркера доступа в конечную точку API. Маркер доступа можно получить, отправив сообщение POST на URL-адрес маркера доступа. В пользовательском интерфейсе Центра партнеров отображается URL-адрес маркера доступа.

Версия 1 использует секреты. Пользовательский интерфейс в Центре партнеров предоставляет секреты.

Конечные точки REST используют определенные заголовки запросов для версии 1.

Общие сведения об использовании REST API обновления

Чтобы использовать REST API обновления, выполните следующие действия:

v1.1

1. На панели мониторинга разработчика Центра партнеров согласитесь на использование пользовательского интерфейса, использующего ключи API, нажав кнопку Включить рядом, чтобы включить новый интерфейс. Дополнительные сведения см . в разделе Включение REST API обновления в Центре партнеров ниже.

2. Запишите идентификатор клиента и новый ключ API.

3. При необходимости обновите рабочие процессы проверки подлинности.

4. Перенастройте все конвейеры непрерывной интеграции и непрерывной поставки (CI/CD), на которые могут повлиять любые изменения ключа API, например если вы переходите с версии 1 этого REST API, в котором вместо ключей API используются маркеры доступа.

5. При использовании конечной точки REST укажите ClientID и ключ API в заголовке запроса. Дополнительные сведения см. в разделе Использование конечных точек API ниже.

версия 1

1. На панели мониторинга разработчика Центра партнеров получите маркер доступа из URL-адреса маркера доступа. Дополнительные сведения см . в разделе Включение REST API обновления в Центре партнеров ниже.

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

3. При необходимости обновите рабочие процессы проверки подлинности.

4. Повторно настройте все существующие конвейеры непрерывной интеграции и непрерывной доставки (CI/CD), на которые могут повлиять изменения URL-адреса маркера доступа.

5. Получите маркер доступа. Подробные сведения см. в разделе Получение маркера доступа ниже.

6. При использовании конечной точки REST укажите маркер доступа в заголовке запроса. Дополнительные сведения см. в разделе Использование конечных точек API ниже.

Подробные сведения приведены ниже.

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

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

Включение REST API обновления в Центре партнеров

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

v1.1

1. На панели мониторинга разработчика Центра партнеров войдите в учетную запись, используемую для публикации надстройки.

2. В программе Microsoft Edge выберите Опубликовать API.

3. Рядом с сообщением "Включить новый интерфейс" нажмите кнопку Включить :

   

   На приведенном выше снимку экрана показан пользовательский интерфейс версии 1, включая URL-адрес маркера доступа и секреты, перед нажатием кнопки Включить , чтобы переключиться на пользовательский интерфейс версии 1.1.

4. На странице Публикация API нажмите кнопку Создать учетные данные API . Выполнение этого шага может занять несколько минут.

   Идентификатор клиента и новый ключ API создаются автоматически:

   

   Учетные данные API созданы; вы включили или обновили API. На странице Публикация API теперь отображаются следующие элементы:

   • Идентификатор клиента.
   • Ключи API.
     • Дата окончания срока действия для каждого ключа API.

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

   • Идентификатор клиента.
   • Новый ключ API.

   При использовании конечной точки REST вы будете использовать идентификатор клиента и ключ API в заголовке запроса.

версия 1

1. На панели мониторинга разработчика Центра партнеров войдите в учетную запись, используемую для публикации надстройки.

2. В программе Microsoft Edge выберите Опубликовать API.

3. На странице Публикация API нажмите кнопку Создать учетные данные API . Выполнение этого шага может занять несколько минут.

   Учетные данные API созданы; вы включили или обновили API. На странице Публикация API теперь отображаются следующие элементы:

   • Идентификатор клиента.
   • URL-адрес маркера доступа.
   • Секреты клиента.
     • Дата окончания срока действия каждого секрета.

   

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

   • Идентификатор клиента.
   • URL-адрес маркера доступа.
   • Новый секрет клиента.

   Вы будете использовать идентификатор клиента, URL-адрес маркера доступа и секрет клиента для получения маркера доступа в расчете На получение маркера доступа ниже . Затем вы будете использовать маркер доступа в заголовке запроса при использовании конечной точки REST.

Важно!

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

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

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

Маркер доступа можно получить, отправив сообщение POST на URL-адрес маркера доступа. В пользовательском интерфейсе Центра партнеров отображается URL-адрес маркера доступа, который совпадает с приведенным в этой статье. Затем маркер доступа включается в заголовок при использовании конечной точки API, например конечной точки для отправки пакета для обновления существующей отправки ниже.

Описание конечной точки, используемой для получения маркера доступа:

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

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

Например, чтобы получить маркер доступа, отправьте запрос POST на URL-адрес маркера доступа, введя команду в командной curl строке следующим образом:

> 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

REST API обновления предоставляет конечные точки для:

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

Эти конечные точки представлены ниже.

Чтобы использовать этот REST API обновления надстроек Microsoft Edge, необходимо следующее:

v1.1

Ключ API и идентификатор клиента.

версия 1

Маркер доступа.

API доступен в корневом каталоге https://api.addons.microsoftedge.microsoft.comконечной точки .

Конечные точки REST API отсутствуют для:

• Создание нового продукта.
• Обновление метаданных продукта, таких как описание.

Чтобы создать новый продукт или обновить его метаданные, необходимо использовать Центр партнеров Майкрософт.

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

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

См . также раздел Отправка пакета для обновления существующей отправки в справочнике по REST API для обновления надстроек Microsoft Edge.

Описание конечной точки

v1.1

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

версия 1

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, которую требуется обновить.

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

1. Войдите на панель мониторинга разработчика Центра партнеров.

2. Перейдите в раздел Обзор Microsoft Edge>.

3. Выберите расширение, для которого требуется идентификатор продукта.

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

4. В разделе Удостоверение расширения (или в адресной строке) выберите и скопируйте идентификатор продукта.

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

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

v1.1

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

версия 1

> 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 объект , необходимый для проверки состояния операции обновления.

См. также:

• Отправьте пакет для обновления существующей отправки в справочнике по REST API для обновления надстроек Microsoft Edge.

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

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

$operationID — это идентификатор операции, возвращенный в заголовке ответа при отправке пакета для обновления существующей отправки или публикации отправки.

См. также сведения о состоянии публикации в справочнике по REST API для обновления надстроек Microsoft Edge.

Описание конечной точки

v1.1

Endpoint: /v1/products/$productID/submissions/draft/package/operations/$operationID
Type: GET
Header Parameters: Authorization: ApiKey $ApiKey; X-ClientID: $ClientID

версия 1

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

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

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

v1.1

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

версия 1

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

См. также:

• Проверьте состояние отправки пакета в справочнике по REST API для обновления надстроек Microsoft Edge.

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

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

См. также публикацию отправки черновика продукта в справочнике по REST API для обновления надстроек Microsoft Edge.

Описание конечной точки

v1.1

Endpoint: /v1/products/$productID/submissions
Type: POST
Header Parameters: Authorization: ApiKey $ApiKey; X-ClientID: $ClientID
Body content: Notes for certification, in JSON format

версия 1

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

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

Чтобы опубликовать отправку curl , используйте команду в командной строке следующим образом:

v1.1

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

версия 1

> 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 объект , необходимый для проверки состояния операции публикации.

См. также:

• Опубликуйте отправку черновика продукта в справочнике по REST API для обновления надстроек Microsoft Edge.

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

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

$operationID — это идентификатор операции, возвращенный в заголовке ответа при отправке пакета для обновления существующей отправки или публикации отправки.

См. также сведения о состоянии публикации в справочнике по REST API для обновления надстроек Microsoft Edge.

Описание конечной точки

v1.1

Endpoint: /v1/products/$productID/submissions/operations/$operationID
Type: GET
Header Parameters: Authorization: ApiKey $ApiKey; X-ClientID: $ClientID

версия 1

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

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

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

v1.1

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

версия 1

> 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 — REST API для обновления расширения.
• Поддерживаемые API для расширений Microsoft Edge — API JavaScript для разработки расширения.

GitHub:

• Проблемы в edge-developer репозитории для документации разработчика Microsoft Edge.

платформа удостоверений Майкрософт:

• платформа удостоверений Майкрософт и поток учетных данных клиента OAuth 2.0