App Center API 文档

项目
2025-05-05

重要

Visual Studio App Center 于 2025 年 3 月 31 日停用，但分析和诊断功能除外，这些功能将继续受支持，直到 2026 年 6 月 30 日。了解详细信息。

App Center OpenAPI 规范（Swagger）

App Center 公开一组完整的 API 终结点。可以通过 App Center OpenAPI 规范浏览 App Center API。

App Center OpenAPI 规范允许你使用 API 令牌进行身份验证。进行身份验证后，可以调用 App Center API 来了解该 API 并查看它返回的数据。

令牌类型：用户令牌和应用令牌

App Center 公开两种类型的 API 令牌：用户令牌和应用令牌。

用户 API 令牌具有与 App Center 用户相同的权限。用户 API 令牌适用于你关联的所有组织和应用。

应用 API 令牌具有管理器或查看器权限，但只有一个应用内。

每个 App Center 帐户最多可以创建 5000 个 API 令牌。

小窍门

我们建议创建和使用应用 API 令牌，以一次仅将授权范围限制为一个应用（如果公开令牌，则会限制风险）。如果需要自动执行一个应用以外的某些内容，例如使用组织或共享通讯组，则应创建用户 API 令牌。

警告

不要将 API 令牌嵌入源代码中。 API 令牌应被视为机密，并安全地存储。

警告

POST/PUT/PATCH API 调用必须包含负载内容。 使用 {} 作为空负载正文，否则 API 调用将收到 411 长度必需 错误响应。

创建 App Center 应用 API 令牌

使用帐户凭据导航到 https://appcenter.ms 并登录。
选择应用，为其创建 API 令牌。
在左侧，选择“设置”。
在中间面板中，从菜单列表中选择 “应用 API 令牌 ”。
在右上角，单击“ 新建 API 令牌”。
在文本字段中，输入令牌的描述性名称。
选择应用 API 令牌的访问类型：

完全访问权限： 完全访问应用 API 令牌具有该应用的管理器权限。只有管理员才能创建完全访问的应用 API 令牌。

只读： 只读应用 API 令牌具有与该应用查看器访问权限相同的权限。经理和开发人员可以创建只读应用 API 令牌。
在面板底部，单击“ 添加新 API 令牌”。
此时会打开一个弹出窗口，其中包含应用程序的 API 令牌。 复制并将其存储在安全位置 供以后使用。出于安全原因，单击“ 关闭 ”按钮后，无法再次看到或生成相同的令牌。
单击“ 关闭 ”按钮。

创建 App Center 用户 API 令牌

使用帐户凭据导航到 https://appcenter.ms 并登录。
在 App Center 门户右上角，单击帐户头像，然后选择“帐户设置”。
在中间面板中，从菜单列表中选择 “用户 API 令牌 ”。
在右上角，单击“ 新建 API 令牌”。
在文本字段中，输入令牌的描述性名称。
选择用户 API 令牌的访问类型：

完全访问权限： 完全访问权限用户 API 令牌具有当前帐户/组织拥有的所有权限。例如，如果你没有应用的经理或开发人员权限，则即使你使用的是完全访问权限的用户 API 令牌，用户也无法运行测试。

只读： 只读用户 API 令牌具有当前帐户/组织的查看器访问权限。例如，使用只读用户 API 令牌，您可以读取崩溃数据、分析数据，并获取基本的应用信息。只读用户 API 令牌无法更改应用设置、创建导出配置等。
在面板底部，单击“ 添加新 API 令牌”。
此时会打开一个弹出窗口，其中包含你的用户 API 令牌。 复制并将其存储在安全位置 供以后使用。出于安全原因，单击“ 关闭 ”按钮后，无法再次看到或生成相同的令牌。
单击“ 关闭 ”按钮。

在 API 请求中使用 API 令牌

从应用程序将 API 请求发送到 App Center 时，必须将 API 令牌包含在发送到 App Center 的每个请求的标头中。

在请求的 X-API-Token 标头属性中传递 API 令牌。

查找 App Center 应用名称和所有者名称

某些 App Center 的 API 函数和 CLI 请求需要应用名称或所有者名称作为参数。

例如，从应用中删除用户的 API 调用需要两者： DELETE /v0.1/apps/{owner_name}/{app_name}/users/{user_email}

可以从 App Center URL 或使用 App Center CLI 找到应用名称和所有者名称。

从 App Center URL 中提取 owner_name 和 app_name

请导航至 https://appcenter.ms
进入应用。
当您查看应用程序的 URL 时，它的格式为 https://appcenter.ms/users/{owner-name}/apps/{app-name}。

所有者可以是用户或组织。例如：

所有者	网址	所有者名称	应用名称
用户	`https://appcenter.ms/users/AlexLerxst/apps/Caravan-01`	AlexLerxst	大篷车-01
组织	`https://appcenter.ms/orgs/BallardFlowers/apps/BouquetOrders-app`	Ballard鲜花	花束订单应用程序

从 App Center CLI 查找 owner_name 和 app_name

如果尚未安装 App Center CLI，可以在 App Center CLI 文档中找到安装和使用说明。

安装后，通过运行以下命令检索你有权访问的应用列表：

appcenter apps list

App Center CLI 将显示应用列表，格式 {owner-name}/{app-name}为。

有关命令行函数的完整列表，请参阅 App Center CLI 文档。

将 API 令牌与 App Center OpenAPI 规范配合使用

App Center OpenAPI 规范会为你处理 API 身份验证，因此无需将 API 令牌粘贴到请求的标头中。若要使用 API 令牌测试 App Center API，请执行以下作：

导航到 App Center 的 OpenAPI 规范以浏览我们的 API。
在右上角，单击“ 授权 ”按钮。
在 APIToken 部分下，将 API 令牌粘贴到 “值 ”中，然后单击“ 授权”。
如果显示“已授权”和“注销”按钮，则授权已成功。在弹出窗口的右上角，单击“X”退出弹出窗口。

使用 OpenAPI 进行第一次 API 调用（Swagger）

本部分介绍如何通过 API 调用使用 App Center 的 GET /v0.1/user。此 API 调用返回用户的配置文件数据。

按照上述说明创建 API 令牌。
按照上一部分中的说明授权 OpenAPI 规范页面使用 API 令牌。
在“帐户”下，点击GET /v0.1/user按钮。
在左侧角落，单击“ 试用” 按钮。
单击“参数”部分下的“执行”按钮。
太棒了！现在可以在 “响应 ”部分下看到响应。

撤销 API 令牌

如果 API 令牌泄露，应立即撤销该令牌，以防止未经授权的访问 App Center 帐户。

撤消用户 API 令牌

请导航至 https://appcenter.ms
在 App Center 门户右上角，单击帐户头像，然后选择“帐户设置”。
在中间面板中，从菜单中选择 “用户 API 令牌 ”。
选中要撤销的令牌旁边的框，然后单击右上角的 “删除 ”按钮。

撤消应用 API 令牌

请导航至 https://appcenter.ms
选择要撤销 API 令牌的应用。
在左侧，选择“设置”。
在中间面板中，从菜单中选择 “应用 API 令牌 ”。
选中要撤销的令牌旁边的框，然后单击右上角的 “删除 ”按钮。

通过