获取所有应用

在 Microsoft 应用商店提交 API 中使用此方法,检索注册到合作伙伴中心帐户的应用的数据。

先决条件

若要使用此方法,首先需要执行以下操作:

  • 如果尚未这样做,请完成Microsoft应用商店提交 API 的所有 先决条件
  • 获取 Azure AD 访问令牌,以供在此方法的请求标头中使用。 获取访问令牌后,在它到期前,你有 60 分钟的使用时间。 令牌过期后,可以获取一个新令牌。

请求

此方法具有以下语法。 有关标头和请求正文的使用示例和说明,请参阅以下部分。

方法 请求 URI
获取 https://manage.devcenter.microsoft.com/v1.0/my/applications

请求标头

标题 类型 DESCRIPTION
授权 字符串 必填。 Azure AD 访问令牌,形式为Bearer<token>。

请求参数

此方法的所有请求参数都是可选的。 如果在不使用参数的情况下调用此方法,响应将包含注册到帐户的前 10 个应用的数据。

参数 类型 DESCRIPTION 必选
顶部 整数 (int) 请求中要返回的项数(即要返回的应用数)。 如果您的帐户中拥有的应用程序数量超过您在查询中指定的值,响应正文将包含一个相对 URI 路径,您可以将其附加到方法 URI 来请求下一页的数据。
跳过 整数 (int) 在返回剩余项之前,查询中要绕过的项数。 使用此参数可分页浏览数据集。 例如,top=10 和 skip=0 检索项 1 到 10,top=10 和 skip=10 检索项 11 到 20,依依如此。

请求主体

请勿为此方法提供请求主体。

请求示例

以下示例演示如何检索注册到帐户的前 10 个应用。

GET https://manage.devcenter.microsoft.com/v1.0/my/applications HTTP/1.1
Authorization: Bearer <your access token>

以下示例演示如何检索注册到帐户的所有应用的相关信息。 首先,获取前 10 个应用:

GET https://manage.devcenter.microsoft.com/v1.0/my/applications?top=10 HTTP/1.1
Authorization: Bearer <your access token>

然后以递归方式调用 GET https://manage.devcenter.microsoft.com/v1.0/my/{@nextLink},直到 {@nextlink} 为 null 或响应中不存在。 例如:

GET https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=10&top=10 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=20&top=10 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=30&top=10 HTTP/1.1
Authorization: Bearer <your access token>

如果已知道帐户中已有的应用总数,只需在 顶部 参数中传递该数字即可获取有关所有应用的信息。

GET https://manage.devcenter.microsoft.com/v1.0/my/applications?top=23 HTTP/1.1
Authorization: Bearer <your access token>

响应

以下示例演示了成功请求向开发人员帐户注册的前 10 个应用(总共 21 个应用)返回的 JSON 响应正文。 为简洁起见,此示例仅显示请求返回的前两个应用的数据。 有关响应正文中的值的更多详细信息,请参阅以下部分。

{
  "@nextLink": "applications?skip=10&top=10",
  "value": [
    {
      "id": "9NBLGGH4R315",
      "primaryName": "Contoso sample app",
      "packageFamilyName": "5224ContosoDeveloper.ContosoSampleApp_ng6try80pwt52",
      "packageIdentityName": "5224ContosoDeveloper.ContosoSampleApp",
      "publisherName": "CN=…",
      "firstPublishedDate": "2016-03-11T01:32:11.0747851Z",
      "pendingApplicationSubmission": {
        "id": "1152921504621134883",
        "resourceLocation": "applications/9NBLGGH4R315/submissions/1152921504621134883"
      }
    },
    {
      "id": "9NBLGGH29DM8",
      "primaryName": "Contoso sample app 2",
      "packageFamilyName": "5224ContosoDeveloper.ContosoSampleApp2_ng6try80pwt52",
      "packageIdentityName": "5224ContosoDeveloper.ContosoSampleApp2",
      "publisherName": "CN=…",
      "firstPublishedDate": "2016-03-12T01:49:11.0747851Z",
      "lastPublishedApplicationSubmission": {
        "id": "1152921504621225621",
        "resourceLocation": "applications/9NBLGGH29DM8/submissions/1152921504621225621"
      }
      // Next 8 apps are omitted for brevity ...
    }
  ],
  "totalCount": 21
}

响应体

价值 类型 DESCRIPTION
价值 数组 一个对象数组,其中包含有关注册到帐户的每个应用的信息。 有关每个对象中的数据的详细信息,请参阅 应用程序资源
@nextLink 字符串 如果有其他数据页,此字符串包含一个相对路径,可以附加到基础 https://manage.devcenter.microsoft.com/v1.0/my/ 请求 URI 上以请求下一页数据。 例如,如果初始请求正文的 顶部 参数设置为 10,但帐户中注册了 20 个应用,则响应正文将包含 @nextLink 值 applications?skip=10&top=10,这表示可以调用 https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=10&top=10 来请求接下来的 10 个应用。
总计数 整数 (int) 查询的数据结果中的总行数(即注册到帐户的应用总数)。

错误代码

如果请求无法成功完成,响应将包含以下 HTTP 错误代码之一。

错误代码 DESCRIPTION
404 找不到任何应用。
409 这些应用使用 Microsoft应用商店提交 API当前不支持的合作伙伴中心功能。