Skip to content

Commit

Permalink
Merge pull request #3100 from MicrosoftDocs/user/mikehoffms/rest
Browse files Browse the repository at this point in the history
Add REST before "API" in title, remove 3rd-party table
  • Loading branch information
captainbrosset authored Mar 13, 2024
2 parents c555313 + c7f23a0 commit 50733ca
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 30 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Microsoft Edge Add-ons API Reference
title: REST API Reference for Microsoft Edge Add-ons
description: The Add-ons API Reference, for REST endpoints to automate publishing updates to add-ons that are submitted to the Microsoft Edge Add-ons store.
author: MSEdgeTeam
ms.author: msedgedevrel
Expand All @@ -8,11 +8,11 @@ ms.service: microsoft-edge
ms.subservice: extensions
ms.date: 11/07/2022
---
# Microsoft Edge Add-ons API Reference
# REST API Reference for Microsoft Edge Add-ons

This article is the REST endpoint reference for the Microsoft Edge Add-ons API. This API automates publishing updates to add-ons that have been submitted to the Microsoft Edge Add-ons store.

For an overview, see [Using the Microsoft Edge Add-ons API](using-addons-api.md).
For an overview, see [Using the Microsoft Edge Add-ons REST API](using-addons-api.md).


<!-- ====================================================================== -->
Expand Down Expand Up @@ -84,7 +84,7 @@ Gets the status of the package upload.

| URI parameter | Description |
|---|---|
| `operationID` | Required. The operation ID of the upload request submitted in the previous step. This information is available in the response header.
| `operationID` | Required. The operation ID of the upload request submitted in the previous step. This information is available in the response header. |

###### Request headers

Expand Down Expand Up @@ -397,7 +397,7 @@ Here's a list of common error codes and possible reasons. For a full list, see
|---|---|---|
| 400 Bad Request | The server didn't understand the request. | There's no package (zip file) in the body. Or, `Content-Type` header is missing or its value is incorrect. |
| 401 Unauthorized | The request page needs an authorization. | The auth token is missing, expired, or not valid. |
| 404 Not Found | The server can't find the requested page. | The specified `productID` or `operationID` doesn't have a valid GUID, isn't valid, or doesn't belong to the developer who is making the request. |
| 404 Not Found | The server can't find the requested page. | The specified `productID` or `operationID` doesn't have a valid GUID, isn't valid, or doesn't belong to the developer who is making the request. |
| 408 Request Timeout | The request took longer than the server was prepared to wait. | There was a timeout while uploading a package. |
| 429 Too many requests | Too many requests were sent by the user. | Too many requests were sent and they got throttled. |

Expand All @@ -411,4 +411,4 @@ Here's a list of common error codes and possible reasons. For a full list, see
<!-- ====================================================================== -->
## See also

* [Using the Microsoft Edge Add-ons API](using-addons-api.md)
* [Using the Microsoft Edge Add-ons REST API](using-addons-api.md)
16 changes: 4 additions & 12 deletions microsoft-edge/extensions-chromium/publish/api/using-addons-api.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,20 @@
---
title: Using the Microsoft Edge Add-ons API
title: Using the Microsoft Edge Add-ons REST API
description: REST endpoints to automate publishing updates to add-ons that are submitted to the Microsoft Edge Add-ons store.
author: MSEdgeTeam
ms.author: msedgedevrel
ms.topic: conceptual
ms.service: microsoft-edge
ms.subservice: extensions
ms.date: 07/19/2023
ms.date: 03/12/2024
---
# Using the Microsoft Edge Add-ons API
# Using the Microsoft Edge Add-ons REST API

The Microsoft Edge Add-ons API provides a set of REST endpoints for programmatically publishing updates to add-ons submitted to the Microsoft Edge Add-ons store. You can use these REST endpoints to automate the process of uploading and publishing new versions of your add-ons to the Microsoft Edge Add-ons store. You'll use the **Publish API** page at Partner Center to work with these endpoints.

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]).


<!-- ====================================================================== -->
## Library Support

| Language | Package | Source code | Notes |
| --- | --- | --- | --- |
| Node.js | [Edge Webstore Upload](https://www.npmjs.com/package/@plasmo-corp/ewu) | [GitHub](https://github.com/plasmo-corp/edge-webstore-upload)| This is a third party library. Microsoft makes no warranties, express or implied, with respect to the information provided here. |


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

Expand Down Expand Up @@ -232,4 +224,4 @@ https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submission


See also:
* [Using the Microsoft Edge Add-ons API: Check the publishing status](addons-api-reference.md#check-the-publishing-status)
* [Using the Microsoft Edge Add-ons REST API: Check the publishing status](addons-api-reference.md#check-the-publishing-status)
13 changes: 4 additions & 9 deletions microsoft-edge/extensions-chromium/publish/update-extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,11 @@ To update your extension on the store, follow these steps:

1. Update either the extension package or the metadata of the extension. If you update the extension package, make sure that you increase the version number in the manifest file.

1. After you make the changes, select **Publish** to update your extension listing, and start the certification process.

> [!NOTE]
> The certification process for an update to an extension can take up to 7 business days.
1. After you make the changes, click **Publish** to update your extension listing and start the certification process. The certification process for an update to an extension can take up to 7 business days.

1. After the `Status` column displays `In the store`, your extension update is available on the Microsoft Edge Add-ons website.

> [!TIP]
> After your extension has been created initially, you'll be able to update it programmatically [Using the Microsoft Edge Add-ons API (Beta)](api/using-addons-api.md).
After your extension has been created initially, you can update your extension by [Using the Microsoft Edge Add-ons REST API](./api/using-addons-api.md).


<!-- ====================================================================== -->
Expand All @@ -46,12 +42,11 @@ To edit your submission, follow these steps:

1. To open the **Extension overview** section, use the left navigation bar. To cancel the current submission, select **Cancel submission**.

1. Go to other sections and update either the extension package or the metadata of the extension. If you update the extension package, make sure that you increase the version number in the manifest file to match changes since the previous package submission.
1. Go to other sections and update either the extension package or the metadata of the extension. If you update the extension package, make sure that you increase the version number in the manifest file to match changes that were made after the previous package submission.

1. After you finish making changes, select **Publish**.

> [!IMPORTANT]
> The process stops and removes your current submission from the Microsoft Edge extensions certification pipeline and a new review starts with the latest submission.
**Important:** The review process stops, your current submission is removed from the Microsoft Edge extensions certification pipeline, and then a new review starts, using the new submission.


<!-- ====================================================================== -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Microsoft Partner Center only accepts new Manifest V3 Microsoft Edge extension s

*Released July 2022*


<!-- ====================================================================== -->
## You can respond to user reviews about your Microsoft Edge Add-on

Expand All @@ -37,76 +38,87 @@ To share your feedback and comments about this feature, see [GitHub discussion t

*Released May 2022*


<!-- ====================================================================== -->
## Publish and update extensions using the Microsoft Edge Add-ons API

You can integrate APIs directly into your Continuous Integration / Continuous Delivery (CI/CD) pipeline. You can also publish extension package updates to the Microsoft Edge Add-ons website without using Partner Center. For more information, see [Using the Microsoft Edge Add-ons API](/microsoft-edge/extensions-chromium/publish/api/using-addons-api)
You can integrate APIs directly into your Continuous Integration / Continuous Delivery (CI/CD) pipeline. You can also publish extension package updates to the Microsoft Edge Add-ons website without using Partner Center. For more information, see [Using the Microsoft Edge Add-ons REST API](../publish/api/using-addons-api.md).

*Released March 2022*


<!-- ====================================================================== -->
## Addition of breadcrumbs to Microsoft Partner Center

Developers can view the navigation bar / tree path while using Partner Center to track the exact Partner Center path users are visiting. Developers can maintain awareness of their location within Microsoft Partner Center.

*Released March 2022*


<!-- ====================================================================== -->
## Microsoft Edge extensions developer portal

The new edition of the developer portal contains relevant resources and documentation for Microsoft Edge extensions. For more information, see [Microsoft Edge Add-ons Developer](https://developer.microsoft.com/microsoft-edge/extensions/).

*Released January 2022*


<!-- ====================================================================== -->
## Extension Analytics Dashboard on Microsoft Partner Center

The Extensions Analytics Dashboard enables you to view your extension's usage, adoption, and in-market performance. You can also track active user installs, weekly users, total downloads, and usage distribution over a period from [Partner Center](https://partner.microsoft.com/dashboard/microsoftedge/).

*Released September 2021*


<!-- ====================================================================== -->
## Add team members to your Partner Center account

You can add members from your organization and manage the settings on your Partner Center Account. See [Add users to the Microsoft Edge program](/microsoft-edge/extensions-chromium/publish/aad-account).

*Released August 2021*


<!-- ====================================================================== -->
## Sign into Microsoft Partner Center using your GitHub account

You can use your personal GitHub account credentials to sign into Microsoft Partner Center to submit your Microsoft Edge Extension. See [Publish a Microsoft Edge extension by using a GitHub account](/microsoft-edge/extensions-chromium/publish/github).

*Released August 2021*


<!-- ====================================================================== -->
## Manage your extension submissions on Partner Center

This feature allows you to view your extension submission from the [Partner Center](https://partner.microsoft.com/dashboard/microsoftedge/) dashboard and overview pages. You can easily track your extension submission review status, view past updates, view the status of submissions, and manage extensions on Partner Center.

*Released May 2021*


<!-- ====================================================================== -->
## Support for Manifest V3 extensions

Microsoft Edge Add-ons now support extensions with Manifest V3. For more information, see the blog [Manifest V3 changes are now available in Microsoft Edge](https://techcommunity.microsoft.com/t5/articles/manifest-v3-changes-are-now-available-in-microsoft-edge/m-p/1780254) for more details.

*Released April 2021*


<!-- ====================================================================== -->
## Request to get your extension featured

You can request the Collection where your extension should be featured on the Microsoft Edge Add-ons store. You can submit your request at the [Submit a request to add an extension to the collections on the Microsoft Edge Add-ons home page](https://forms.office.com/pages/responsepage.aspx?id=v4j5cvGGr0GRqy180BHbRw01UwyBfAxNna_1ZkP3X2VUN0lBSU1YMEU3VFY0VURRODEwSjgwU00yRy4u).

*Released April 2021*


<!-- ====================================================================== -->
## Extension store listing localization

You can choose a subset of languages instead of manually entering each language in the listing details on Microsoft Partner Center. You can also elect to use the same marketing assets across all marketplaces. See [Partner Center improvements related to Microsoft Edge extensions store listing and certification](https://techcommunity.microsoft.com/t5/articles/partner-center-improvements-related-to-microsoft-edge-extensions/m-p/2118981).

*Released February 2021*


<!-- ====================================================================== -->
## Extension certification report link

Expand Down
4 changes: 2 additions & 2 deletions microsoft-edge/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1030,10 +1030,10 @@

- name: Microsoft Edge Add-ons API
items:
- name: Using the Microsoft Edge Add-ons API
- name: Using the Microsoft Edge Add-ons REST API
href: extensions-chromium/publish/api/using-addons-api.md

- name: Microsoft Edge Add-ons API Reference
- name: REST API Reference for Microsoft Edge Add-ons
href: extensions-chromium/publish/api/addons-api-reference.md

- name: Samples
Expand Down

0 comments on commit 50733ca

Please sign in to comment.