Compartir a través de

Uso de la API REST de complementos de Microsoft Edge

  • Artículo

La API de complementos de Microsoft Edge proporciona un conjunto de puntos de conexión REST para publicar mediante programación actualizaciones en complementos enviados al almacén de complementos de Microsoft Edge. Puede usar estos puntos de conexión REST para automatizar el proceso de carga y publicación de nuevas versiones de los complementos en el almacén de complementos de Microsoft Edge. Usará la página Publicar API en el Centro de partners para trabajar con estos puntos de conexión.

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

Terminología

Término Definición
operation Una operación REST como GET o PUT.
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).

Antes de empezar

Para usar la API de complementos de Microsoft Edge, debe habilitar la API para el proyecto en el Centro de partners de Microsoft mediante la creación de credenciales de API. Siga estos pasos para crear credenciales de API.

  1. Visite el Centro de partners de Microsoft e 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. El identificador de cliente, el secreto de cliente, la fecha de expiración y la dirección URL del token de acceso ahora se muestran en la página Publicar API:

    La página

  4. Anote el identificador de cliente, el secreto de cliente y la dirección URL del token de acceso. Usará estos valores en el paso siguiente para obtener un token de acceso.

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

Una vez que haya adquirido la autorización necesaria para la aplicación, obtenga tokens de acceso para las API. Para obtener un token mediante la concesión de credenciales de cliente, envíe una solicitud POST a la dirección URL del token de Access (el token de OAuth). La información del inquilino está disponible en la dirección URL que recibió en los pasos anteriores antes de comenzar .

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 muestra

> 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 muestra

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

Para obtener más información, consulte Flujo de credenciales de cliente de OAuth 2.0 en el Plataforma de identidad de Microsoft.

Uso de los puntos de conexión de API

Después de tener un token de acceso, puede usar la API de complementos de Microsoft Edge. Esta API expone puntos de conexión para obtener una lista de productos, actualizar productos y publicar productos.

Nota:

No hay ninguna API para crear un producto o actualizar los metadatos de un producto. Por ejemplo, la descripción. Debe completar estas tareas manualmente en el Centro de partners de Microsoft.

La API está disponible en el punto de conexión https://api.addons.microsoftedge.microsoft.com

Carga de un paquete para actualizar un envío existente

Use esta API 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.

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.

Siga estos pasos para obtener el identificador de producto:

  1. Inicie sesión en el Centro de partners de Microsoft.

  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

> 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:

Comprobación del estado de una carga de paquetes

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

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

Solicitud de ejemplo

> 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:

Publicación del envío

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

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

Solicitud de ejemplo

> 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:

Comprobación del estado de publicación

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

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

Solicitud de ejemplo

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

Vea también: