Skip to content

Commit

Permalink
Update using-addons-api.md
Browse files Browse the repository at this point in the history
updating v2
  • Loading branch information
bhuvanapriyap authored Sep 17, 2024
1 parent 3e840d6 commit 43c6690
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions microsoft-edge/extensions-chromium/publish/api/using-addons-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ The Microsoft Edge Add-ons API provides a set of REST endpoints for programmatic

To submit suggestions and feedback, enter an [Issue about the Add-ons API](https://github.com/MicrosoftDocs/edge-developer/issues/new?title=[Add-ons%20API]).

## Versions of the REST API
As of September 6, 2024, both v2 and v1 of this REST API are supported. Later, v1 will no longer be supported. The date for ending v1 support is not yet finalized.

## Important Notes
Secrets are now API keys in v2
The new Publish API(v2) doesn't require sending an Access Token URL.

<!-- ====================================================================== -->
## Terminology
Expand All @@ -31,7 +37,6 @@ To submit suggestions and feedback, enter an [Issue about the Add-ons API](https
| _product ID_ | The product ID of the product whose draft needs to be published. The product ID is a 128-bit GUID that is associated with a product at Partner Center. For example: `d34f98f5-f9b7-42b1-bebb-98707202b21d`. |
| _submission_ | An update that is being submitted to an existing product at Partner Center. Every update to a product is a submission, regardless of whether the status is `In Draft`, `In Review`, or `In the Store` (published). |


<!-- ====================================================================== -->
## Before you begin

Expand All @@ -43,17 +48,20 @@ To use the Microsoft Edge Add-ons API, you need to enable the API for your proje

1. On the **Publish API** page, click the **Create API credentials** button. This step may take a few minutes to finish.

The API credentials have now been created; you've enabled or renewed the API. The **Client ID**, **Client secret**, **Expiry date**, and **Access token URL** are now displayed on the Publish APIs page:
The API credentials have now been created; you've enabled or renewed the API. The **Client ID**, **Client secret(API key for v2)**, **Expiry date**, and **Access token URL(v1)** are now displayed on the Publish APIs page:

![The 'Publish API' page at Partner Center after clicking 'Create API credentials', now showing Client ID, Client Secret, and Auth Token URL](./using-addons-api-images/create-api-credentials-button.png)

1. Write down the **Client ID**, **Client secret** and the **Access token URL**. You'll use these values in the next step, to get an access token.
1. Write down the **Client ID**, **Client secret(API key for v2)** and the **Access token URL(v1)**. You'll use these values in the next step, to get an access token.

> [!IMPORTANT]
> Publish API Version 1(v1)
> Be sure to write down the client secret now, because it's only visible immediately after enabling or renewing the API (that is, after creating API credentials). This particular secret isn't shown again.
You can generate multiple client secrets for your client ID. For example, you can create multiple secrets for multiple projects.

>Publish API Version 2(v2)
>With the new Publish API, the API key is generated automatically by our backend services. This means that the ClientId and API Keys are regenerated for every developer.
<!-- ====================================================================== -->
## Retrieving the access token
Expand Down Expand Up @@ -225,7 +233,13 @@ Header Parameters: Authorization: Bearer $TOKEN
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/operations/{operationID}
```
## Getting started with v2

> opt-in for the new API key management experience.
> Next, regenerate your ClientId and secrets, which may require updates to your authentication workflows.
> Finally, reconfigure any existing CI/CD pipelines that may be impacted by the changes to access token URL and API key.
See also:
* [Using the Microsoft Edge Add-ons REST API: Check the publishing status](addons-api-reference.md#check-the-publishing-status)
Expand Down

0 comments on commit 43c6690

Please sign in to comment.