IDE Services Cloud Help

REST API

IDE Services 提供了用户界面(Web UI)和应用程序编程接口(API),用于在 IDE 服务服务器 上执行所有关键操作。

IDE 服务拥有公共和私有 REST API 端点。 大部分端点为私有,因此如果出现无法预见的重大变更,将不会有警告或弃用周期。 虽然我们仍然会在发行说明中提供这些重大变更的文档,但我们强烈建议不要使用私有 API。

自动化令牌

对 IDE 服务服务器 的大多数请求都需要 验证 请求头。 它支持:

  • 公司所用外部 OAuth2 服务提供商的 OAuth 2.0 令牌

  • 在 IDE 服务服务器 上创建的自动化令牌

添加自动化令牌

创建自动化令牌

  1. 在 Web UI 中,打开 Configuration (配置) 页面并导航到 Automation Tokens (自动化令牌稿据令牌(Automation Token)稿据令牌(Automation Token) 自动化令牌稿据令牌(Automation Token) 自动化令牌稿据令牌(Automation Token) 自动化令牌稿据令牌(Automation Token)) 标签。

  2. 点击 Create Automation Token (创建自动化令牌)

  3. Create Automation Token (创建自动化令牌) 对话框中,指定令牌名称并设置过期日期。 点击 Create (创建)

    新建自动化令牌

公共 API 端点

目前,以下端点可公开访问:

上传插件至 IDE 服务服务器

POST /api/plugins

从代码仓库上传新插件或插件版本到 IDE 服务服务器。

如需参数和说明,请参阅 通过 cURL 发布插件

AI 分析

AI 相关的指标显示组织内 AI 工具的采纳情况、总体 AI 活跃度及其影响。 获取与 Junie 和 AI 助手的聊天及编辑器内交互的数据,包括涉及的模型和编码智能体。

如需更多信息和说明,请参阅 通过 API 获取 AI 分析数据。

GET /api/analytics/ai/users-adoption

检索关于 AI 功能采纳度的指标,包括指定时间段内的唯一启用用户数和活跃用户数。 更多信息

GET /api/analytics/ai/effectiveness/metrics

检索指定时间段内 AI 工具的聚合活动和影响指标(建议、接受、调用次数)。 选择多个工具时,此端点会将所有工具的所有指标合并为每个时间段的一组值。 更多信息

GET /api/analytics/ai/effectiveness/metrics-by-feature

检索按各个特性(建议、接受、调用次数)分组的工具活动和影响指标,在指定时间段内分别统计每个工具。 在响应中为每个工具获取单独的指标。 更多信息

GET /api/analytics/ai/effectiveness/metrics/totals

检索整个指定时间段不分时间的聚合活动和影响指标。 获取指定时间范围内所有日期的指标汇总。 更多信息

GET /api/analytics/ai/effectiveness/metrics/users.paged

检索带有游标分页的每用户指标数据。 每条记录代表特定用户、日期与工具的指标。 更多信息

Swagger 文档

Swagger API 文档可在 https://<your_organization>/swagger-ui.html 处访问,包含以下三页内容:

  • IDE 服务公共

  • IDE 服务私有

  • License Vault 公共

请使用屏幕右上角的下拉菜单在 Swagger API 各页面间切换。

Swagger
2026年 3月 16日