Uso de la API REST para actualizar complementos de Microsoft Edge

Use esta API REST para actualizar mediante programación una extensión que se ha publicado en el sitio web de complementos de Microsoft Edge para automatizar el proceso de carga y publicación de nuevas versiones de la extensión. Puede integrar estos puntos de conexión de API REST directamente en la canalización de integración continua/entrega continua (CI/CD) para publicar actualizaciones de paquetes de extensión en el sitio web de complementos de Microsoft Edge sin usar el Centro de partners.

Esta API REST expone puntos de conexión para:

• Carga de un paquete para actualizar un envío existente
• Comprobación del estado de una carga de paquetes
• Publicación del envío
• Comprobación del estado de publicación

Estos puntos de conexión se describen a continuación.

Para usar esta API REST, use primero la página Publicar API en el Centro de partners para habilitar la API.

Para publicar inicialmente una nueva extensión, use el Centro de partners. Para actualizar la extensión, use manualmente el Centro de partners o use esta API REST mediante programación.

Para enviar sugerencias y comentarios, escriba un problema sobre la API de complementos.

Versiones de la API REST de actualización

A partir del 6 de septiembre de 2024, se admiten las versiones 1.1 y v1 de esta API REST de actualización. La compatibilidad con v1 finalizará el 31 de diciembre de 2024.

Componentes usados

v1.1

v1.1 usa una clave de API. La interfaz de usuario del Centro de partners proporciona claves de API.

Los puntos de conexión REST usan encabezados de solicitud específicos para la versión 1.1.

v1

v1 requiere el envío de un token de acceso al punto de conexión de API. Para obtener el token de acceso, envíe un mensaje POST a una dirección URL del token de acceso. La interfaz de usuario del Centro de partners muestra la dirección URL del token de acceso.

v1 usa Secretos. La interfaz de usuario del Centro de partners proporciona secretos.

Los puntos de conexión REST usan encabezados de solicitud específicos para v1.

Información general sobre el uso de la API REST de actualización

Para usar la API REST de actualización:

v1.1

1. En el panel para desarrolladores del Centro de partners, opte por la interfaz de usuario que usa claves de API; para ello, haga clic en el botón Habilitar situado junto a para habilitar la nueva experiencia. Los detalles se encuentran en Habilitación de la API REST de actualización en el Centro de partners, a continuación.

2. Anote el identificador de cliente y la nueva clave de API.

3. Actualice los flujos de trabajo de autenticación, si es necesario.

4. Vuelva a configurar las canalizaciones de integración o entrega continua (CI/CD) que puedan verse afectadas por cualquier cambio en la clave de API, como si va a cambiar de usar v1 de esta API REST, que usa tokens de acceso en lugar de claves de API.

5. Cuando se usa un punto de conexión REST, especifique clientID y la clave de API en el encabezado de solicitud. Los detalles se encuentran en Uso de los puntos de conexión de API, a continuación.

v1

1. En el panel para desarrolladores del Centro de partners, obtenga un token de acceso desde la dirección URL del token de acceso. Los detalles se encuentran en Habilitación de la API REST de actualización en el Centro de partners, a continuación.

2. Genere el ClientID y los secretos. Puede generar varios secretos de cliente para el identificador de cliente. Por ejemplo, puede crear varios secretos para varios proyectos.

3. Actualice los flujos de trabajo de autenticación, si es necesario.

4. Vuelva a configurar las canalizaciones de integración continua o entrega continua (CI/CD) existentes que puedan verse afectadas por los cambios en la dirección URL del token de acceso.

5. Recupere el token de acceso. Los detalles se encuentran en Recuperar el token de acceso, a continuación.

6. Cuando use un punto de conexión REST, especifique el token de acceso en el encabezado de solicitud. Los detalles se encuentran en Uso de los puntos de conexión de API, a continuación.

A continuación se detallan los detalles.

Terminología

Término	Definición
operation	Una operación REST como GET o POST.
identificador de operación	Identificador de una operación REST.
package	Paquete .zip que contiene los archivos del complemento de Microsoft Edge.
producto	Un tema o extensión de Microsoft Edge. También se conoce como complemento de Microsoft Edge.
id. de producto	Id. de producto del producto cuyo borrador debe publicarse. El identificador de producto es un GUID de 128 bits que está asociado a un producto en el Centro de partners. Por ejemplo: d34f98f5-f9b7-42b1-bebb-98707202b21d.
Sumisión	Actualización que se envía a un producto existente en el Centro de partners. Cada actualización de un producto es un envío, independientemente de si el estado es In Draft, In Reviewo In the Store (publicado).

Habilitación de la API REST de actualización en el Centro de partners

Para usar la API de complementos de Microsoft Edge, primero debe habilitar la API para el proyecto en el Centro de partners de Microsoft mediante la creación de credenciales de API, como se indica a continuación:

v1.1

1. En el panel para desarrolladores del Centro de partners, inicie sesión en la cuenta que usó para publicar un complemento.

2. En el programa Microsoft Edge , seleccione Publicar API.

3. Junto al mensaje "Habilitar la nueva experiencia", haga clic en el botón Habilitar :

   

   En la captura de pantalla anterior se muestra la interfaz de usuario v1, incluida la dirección URL del token de Acceso y los secretos, antes de hacer clic en el botón Habilitar para cambiar a la interfaz de usuario v1.1.

4. En la página Publicar API , haga clic en el botón Crear credenciales de API . Este paso puede tardar unos minutos en finalizar.

   El identificador de cliente y una nueva clave de API se generan automáticamente:

   

   Ahora se han creado las credenciales de API; ha habilitado o renovado la API. Ahora se muestran los siguientes elementos en la página Publicar API :

   • El identificador de cliente.
   • Claves de API.
     • Fecha de expiración de cada clave de API.

5. Anote lo siguiente:

   • Identificador de cliente.
   • La nueva clave de API.

   Usará el identificador de cliente y la clave de API en el encabezado de solicitud cuando use un punto de conexión REST.

v1

1. En el panel para desarrolladores del Centro de partners, inicie sesión en la cuenta que usó para publicar un complemento.

2. En el programa Microsoft Edge , seleccione Publicar API.

3. En la página Publicar API , haga clic en el botón Crear credenciales de API . Este paso puede tardar unos minutos en finalizar.

   Ahora se han creado las credenciales de API; ha habilitado o renovado la API. Ahora se muestran los siguientes elementos en la página Publicar API :

   • El identificador de cliente.
   • La dirección URL del token de Access.
   • Secretos de cliente.
     • Fecha de expiración de cada secreto.

   

4. Anote lo siguiente:

   • Identificador de cliente.
   • Dirección URL del token de acceso.
   • Nuevo secreto de cliente.

   Usará el identificador de cliente, la dirección URL del token de acceso y el secreto de cliente para obtener un token de acceso, por Recuperación del token de acceso, debajo de . A continuación, usará el token de acceso en el encabezado de solicitud al usar un punto de conexión REST.

Importante

Asegúrese de anotar el secreto de cliente ahora, ya que solo está visible inmediatamente después de habilitar o renovar la API (es decir, después de crear credenciales de API). Este secreto en particular no se muestra de nuevo.

Puede generar varios secretos de cliente para el identificador de cliente. Por ejemplo, puede crear varios secretos para varios proyectos.

Recuperación del token de acceso

Para obtener un token de acceso, envíe un mensaje POST a una dirección URL del token de acceso. La interfaz de usuario del Centro de partners muestra la dirección URL del token de acceso, que es la misma que en este artículo. A continuación, se incluye el token de acceso en el encabezado cuando se usa un punto de conexión de API, como el punto de conexión para cargar un paquete con el fin de actualizar un envío existente, a continuación.

Descripción del punto de conexión que se va a usar para obtener un token de acceso:

REST

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

Solicitud de ejemplo

Por ejemplo, para obtener un token de acceso, envíe una solicitud POST a la dirección URL del token de acceso; para ello, escriba un curl comando en el símbolo del sistema, como se indica a continuación:

Consola

> 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

Respuesta de ejemplo

Se le devuelve un token de acceso, como:

JSON

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

Para obtener más información, consulte Obtención de un token en Plataforma de identidad de Microsoft y el flujo de credenciales de cliente de OAuth 2.0.

Uso de los puntos de conexión de API

La API REST update expone puntos de conexión para:

• Carga de un paquete para actualizar un envío existente
• Comprobación del estado de una carga de paquetes
• Publicación del envío
• Comprobación del estado de publicación

Estos puntos de conexión se presentan a continuación.

Para usar esta API REST de actualización de complementos de Microsoft Edge, debe tener lo siguiente, según lo anterior:

v1.1

Una clave de API y un identificador de cliente.

v1

Un token de acceso.

La API está disponible en la raíz https://api.addons.microsoftedge.microsoft.comdel punto de conexión .

No hay puntos de conexión de API REST para:

• Crear un nuevo producto.
• Actualizar los metadatos de un producto, como la descripción.

Para crear un producto o actualizar los metadatos de un producto, debe usar el Centro de partners de Microsoft.

Carga de un paquete para actualizar un envío existente

Use este punto de conexión de API REST para actualizar el paquete de un complemento. Esta API carga un paquete para actualizar un borrador de envío existente de un producto de complemento.

Consulte también Carga de un paquete para actualizar un envío existente en referencia de API REST para actualizar complementos de Microsoft Edge.

Descripción del punto de conexión

v1.1

REST

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

v1

REST

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 es el identificador de producto del complemento de Microsoft Edge que desea actualizar.

Para obtener el identificador de producto:

1. Inicie sesión en el panel para desarrolladores del Centro de partners.

2. Vaya aInformación general deMicrosoft Edge>.

3. Seleccione la extensión para la que desea el identificador de producto.

   Se abre la página Información general de la extensión . El identificador de producto se muestra en la página. (El identificador de producto también se muestra como GUID en la dirección URL de la barra de direcciones, entre microsoftedge/ y /packages.)

4. En la sección Identidad de extensión (o en la barra De direcciones), seleccione y copie el id. de producto.

Solicitud de ejemplo

Para cargar un paquete para actualizar un envío existente, use el comando en un símbolo del curl sistema como se indica a continuación:

v1.1

Consola

> 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

v1

Consola

> 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

Si la solicitud se realiza correctamente y comienza el proceso de actualización, recibirá un 202 Accepted código de estado de respuesta con un Location encabezado. Este encabezado de ubicación contiene el operationID que es necesario para comprobar el estado de la operación de actualización.

Vea también:

• Cargue un paquete para actualizar un envío existente en referencia de api rest para actualizar complementos de Microsoft Edge.

Comprobación del estado de una carga de paquetes

Use esta API para comprobar el estado de carga del paquete.

$operationID es el identificador de operación que se devuelve en el encabezado de respuesta de Carga de un paquete para actualizar un envío existente o Publicar el envío.

Consulte también Comprobación del estado de publicación en referencia de LA API REST para actualizar los complementos de Microsoft Edge.

Descripción del punto de conexión

v1.1

REST

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

v1

REST

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

Solicitud de ejemplo

Para comprobar el estado de una carga de paquetes, use el curl comando en el símbolo del sistema como se indica a continuación:

v1.1

Consola

> 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

v1

Consola

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

Vea también:

• Compruebe el estado de una carga de paquetes en referencia de la API REST para actualizar los complementos de Microsoft Edge.

Publicación del envío

Use esta API para publicar el borrador actual del producto en el sitio web de complementos de Microsoft Edge.

Consulte también Publicar el envío del borrador de producto en referencia de la API REST para actualizar los complementos de Microsoft Edge.

Descripción del punto de conexión

v1.1

REST

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

v1

REST

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

Solicitud de ejemplo

Para publicar el envío, use el curl comando en el símbolo del sistema como se indica a continuación:

v1.1

Consola

> 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

v1

Consola

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

Si la solicitud se realiza correctamente y comienza el proceso de publicación, recibirá un 202 Accepted código de estado de respuesta con un Location encabezado. Este encabezado de ubicación contiene el operationID que es necesario para comprobar el estado de la operación de publicación.

Vea también:

• Publique el envío del borrador de producto en referencia de la API REST para actualizar los complementos de Microsoft Edge.

Comprobación del estado de publicación

Use esta API para comprobar el estado de la operación de publicación.

$operationID es el identificador de operación que se devuelve en el encabezado de respuesta de Carga de un paquete para actualizar un envío existente o Publicar el envío.

Consulte también Comprobación del estado de publicación en referencia de LA API REST para actualizar los complementos de Microsoft Edge.

Descripción del punto de conexión

v1.1

REST

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

v1

REST

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

Solicitud de ejemplo

Para comprobar el estado de publicación, use el curl comando en el símbolo del sistema como se indica a continuación:

v1.1

Consola

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

v1

Consola

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

Vea también:

• Compruebe el estado de publicación en referencia de la API REST para actualizar los complementos de Microsoft Edge.

Vea también

• Referencia de API REST para actualizar complementos de Microsoft Edge : API REST para actualizar una extensión.
• API admitidas para extensiones de Microsoft Edge : API de JavaScript para desarrollar una extensión.

GitHub:

• Problemas en el edge-developer repositorio de documentos para desarrolladores de Microsoft Edge.

Plataforma de identidad de Microsoft:

• Plataforma de identidad de Microsoft y el flujo de credenciales de cliente de OAuth 2.0