Skip to content

Stately Studio API

您可以使用 Studio 的 REST API 来访问您在任何外部项目中的项目和机器。这使您能够自动化工作流程，将您的机器与其他项目集成等。

使用 API 可以执行以下操作：

  • 将机器导出为您所需的语言/格式（例如：TypeScript、JavaScript、JSON 等）
  • 获取有关您所需机器的信息
  • 获取有关您项目的信息
  • 获取机器的特定版本

认证：生成 API 密钥​

所有对 Studio 的请求都必须使用 API 密钥进行认证。 您可以为以下两种范围生成 API 密钥：

  • 项目：此密钥将可以访问特定项目中的所有机器。
  • 账户：此密钥将可以访问您账户中的所有项目和机器。

生成项目范围的 API 密钥​

要为项目生成 API 密钥，请打开您感兴趣的项目中的任何机器。然后，点击编辑器页面右上角的“部署”按钮。在出现的模态框中，点击“创建 API 密钥”，并确保将其复制并存储在安全的地方。

Studio 部署模态框的 GIF，突出显示了“创建 API 密钥”按钮。Studio 部署模态框的 GIF，突出显示了“创建 API 密钥”按钮。

生成账户范围的 API 密钥​

要为账户生成 API 密钥，可以在用户设置中进行。在设置中，选择 API 密钥选项卡，然后点击“创建 API 密钥”。确保将其复制并存储在安全的地方。

Studio 设置页面的 GIF，突出显示了“创建 API 密钥”按钮。Studio 设置页面的 GIF，突出显示了“创建 API 密钥”按钮。

发出请求：访问 OpenAPI(Swagger) 文档​

开始使用 Studio API 的最简单方法是使用 OpenAPI(Swagger) 文档。此文档提供了所有可用端点、其参数和预期响应的列表。

授权请求​

要测试 API，您必须首先使用页面右上角的“授权”按钮使用您的 API 密钥进行认证。

Studio OpenAPI 文档的 GIF，突出显示了“授权”按钮。Studio OpenAPI 文档的 GIF，突出显示了“授权”按钮。

测试端点​

认证后，您可以通过点击端点并填写所需参数来测试任何端点。所有参数都可以从机器、机器版本或项目的 URL 中轻松获取。只需在 Studio 中打开机器或项目，并从浏览器地址栏中复制 ID。 然后，使用“试用”按钮向端点发出请求。响应将显示在请求参数下方。