Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add v1.1 info in "Using REST API for updating Add-ons" #3269

Merged
merged 56 commits into from
Sep 24, 2024
Merged
Changes from 3 commits
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
43c6690
Update using-addons-api.md
bhuvanapriyap Sep 17, 2024
d0dcd1a
Merge branch 'main' into v-bhuvana
mikehoffms Sep 18, 2024
8f8baf8
Writer/Editor pass
mikehoffms Sep 18, 2024
75b20b5
full name of API each time
mikehoffms Sep 18, 2024
64ef655
improve v2 intro section
mikehoffms Sep 18, 2024
09e1c96
add todo cmts re: v2 p.c. UI
mikehoffms Sep 18, 2024
05166a6
rewrite h2 Before you begin
mikehoffms Sep 18, 2024
10c49ea
clarify "auto update n/a for P.C. extensions"
mikehoffms Sep 18, 2024
26a2c2a
state scenario of applicability
mikehoffms Sep 18, 2024
fb86547
externally installed extension
mikehoffms Sep 18, 2024
3ec3781
acknowledge externally installed extensions
mikehoffms Sep 18, 2024
edc24c4
normalize leading spaces
mikehoffms Sep 18, 2024
b56265e
norm indents more
mikehoffms Sep 18, 2024
1643cfa
try 4 lead spaces in 1st section 55-71
mikehoffms Sep 18, 2024
a1c9526
desc: & See also h2
mikehoffms Sep 18, 2024
721162f
link to Partner Center. add See also h2 section
mikehoffms Sep 18, 2024
c924fb8
norm'ize Check Status step list
mikehoffms Sep 18, 2024
b8948a8
(CD)
mikehoffms Sep 19, 2024
ec35d2c
link trim
mikehoffms Sep 19, 2024
d24902d
link trim 2
mikehoffms Sep 19, 2024
e1c51d4
Rewrite "Before you begin" headings
mikehoffms Sep 19, 2024
3af0345
Merge branch 'main' into v-bhuvana
mikehoffms Sep 19, 2024
ac59727
typo an Microsoft account
mikehoffms Sep 19, 2024
726b0df
change v2 to v1.1
mikehoffms Sep 19, 2024
4fa992f
tabsets
mikehoffms Sep 19, 2024
6e1520f
key not keys; isolate v1.1 from v1 info; ClientID
mikehoffms Sep 19, 2024
a75eab5
resolved todos
mikehoffms Sep 19, 2024
489899b
p.c. 1.1 pngs, tabsets for code in Using
mikehoffms Sep 19, 2024
26c0144
true code in v1.1 tabs
mikehoffms Sep 19, 2024
0366023
linkfix, add Update to title
mikehoffms Sep 19, 2024
69f67db
shrink "v1.1 vs v1" section, link Overview to h2s
mikehoffms Sep 19, 2024
4f20802
state the png shows initial v1 UI
mikehoffms Sep 19, 2024
5a0995b
token vs url
mikehoffms Sep 19, 2024
7d7fbb8
anchor link fix
mikehoffms Sep 19, 2024
9629da2
reseq title now that it's long
mikehoffms Sep 19, 2024
d7ecfd6
add "update" to Ref article title
mikehoffms Sep 19, 2024
79797c1
clarify lead-in re: access token & url
mikehoffms Sep 19, 2024
957d3b0
title for Using more like for Ref article
mikehoffms Sep 19, 2024
cff19aa
not "cover"; clarif "opt in"
mikehoffms Sep 19, 2024
2d61c95
convert mid-sentence lists
mikehoffms Sep 19, 2024
e155b55
corrected list of endpoints abilities
mikehoffms Sep 19, 2024
6144242
endpoint root
mikehoffms Sep 19, 2024
7ecd579
missing colon X-Client, break curl into 2-3 lines
mikehoffms Sep 20, 2024
575cd08
$varName, hints, tips, links
mikehoffms Sep 20, 2024
842a6dd
revert auth token url to v2.0
mikehoffms Sep 20, 2024
d0d1edb
comment out unclear paragraph
mikehoffms Sep 20, 2024
39b45c2
$varName consistency, keep /v1/
mikehoffms Sep 20, 2024
038a50e
Merge branch 'main' into v-bhuvana
mikehoffms Sep 20, 2024
bd18124
PUT -> POST
mikehoffms Sep 20, 2024
e0e81cc
azure to entra 404
mikehoffms Sep 20, 2024
0cac749
{operationID} to $operationID in send lines
mikehoffms Sep 20, 2024
39a14c5
Update released-features.md
mikehoffms Sep 23, 2024
33c7923
not publish extension. CI/CD expansion
mikehoffms Sep 23, 2024
b967f24
the api --> this api
mikehoffms Sep 23, 2024
b7d9106
restructure Intro
mikehoffms Sep 23, 2024
d8dd8b8
clarify opt in to API key UX
mikehoffms Sep 23, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 37 additions & 4 deletions microsoft-edge/extensions-chromium/publish/api/using-addons-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ms.author: msedgedevrel
ms.topic: conceptual
ms.service: microsoft-edge
ms.subservice: extensions
ms.date: 03/12/2024
ms.date: 09/18/2024
---
# Using the Microsoft Edge Add-ons REST API

Expand All @@ -19,6 +19,32 @@ 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 changes in v2

* v2 of this REST API uses API keys, whereas v1 used Secrets instead.

* v2 of this REST API doesn't require sending an Access Token URL.


<!-- ====================================================================== -->
## Getting started with v2 of this REST API

To use v2 of this REST API:

1. At Partner Center, opt-in to the new API key management experience.

1. Re-generate your ClientId and secrets.<!-- todo: reword, b/c secrets are no longer used, according to "v2 of this REST API uses API keys, whereas v1 used Secrets instead" --> You might need to update your authentication workflows.
mikehoffms marked this conversation as resolved.
Show resolved Hide resolved

1. Re-configure any existing Continuous Integration (CI) or Continuous Development (CD)<!-- todo: does CD stand for Continuous Development? --> pipelines that might be impacted by the changes to the access token URL and API key.
mikehoffms marked this conversation as resolved.
Show resolved Hide resolved


<!-- ====================================================================== -->
## Terminology

Expand All @@ -43,17 +69,24 @@ 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 following items are now displayed on the **Publish API** page:
* **Client ID**
* **Client secret** (for REST API v1) or **API key** (for REST API v2)
* **Expiry date**
* **Access token URL** (for REST API v1)

![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)
mikehoffms marked this conversation as resolved.
Show resolved Hide resolved

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]
> 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.
> This applies only to this REST Publish API v1, not v2:
> 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.

When using v2 of this REST Publish API, the ClientId and API Keys are automatically re-generated, by backend services.<!-- todo: every time you use any endpoint of the REST API? what action causes re-generation of ClientId and API Keys? -->
mikehoffms marked this conversation as resolved.
Show resolved Hide resolved


<!-- ====================================================================== -->
## Retrieving the access token
mikehoffms marked this conversation as resolved.
Show resolved Hide resolved
Expand Down