所有提交到 Onshape 应用商店（OnShape 应用）的应用程序都必须遵循 API 指南：OAuth2 页面上的说明，并使用 OAuth2 进行授权。自动脚本（或不适用于 Onshape 应用商店的应用程序）可能会使用 OAuth2 或 API 密钥进行认证。OAuth2 允许应用程序代表用户调用 Onshape API；API 密钥只能代表生成 API 密钥的 Onshape 用户执行操作。

有关使用 Onshape 应用的更多信息，请参阅 Onshape API 开发者文档。

若要在 Onshape 中导航到您的开发者设置，请单击您位于 Onshape 窗口的右上角的帐户用户图标 (帐户用户图标)。这将打开一个下拉菜单。单击“我的帐户”。

在页面左侧的列表中单击“开发者”：

我的帐户：开发者

API 密钥是创建供个人使用的小型应用程序的有用方法，可让开发者避免 OAuth 工作流程的开销。

API 密钥用于对应用程序进行身份验证，而不是对用户进行身份验证。（OAuth2 通过确保用户有权访问 Onshape 来对应用程序和应用程序用户进行身份验证。）

创建 API 密钥后，它仅在创建 API 密钥的堆栈中有效。在您的公司堆栈（即 companyName.onshape.com）上创建的 API 密钥无法在生产堆栈（cad.onshape.com）上运行。管理员还可以管理公司内用户的 API 密钥：参见公司/教室/企业设置 - 开发者。

查看 API 密钥

  1. 单击“开发者”页面上的 API 密钥。
  2. 查看您之前创建的所有 API 密钥。
    开发者屏幕中列出的 API 密钥

创建 API 密钥

  1. 点击创建新的 API 密钥。
    创建新的 API 密钥屏幕
  2. 在“名称”字段中提供 API 密钥的名称。
  3. 选择密钥的权限。请参阅下面的权限范围。
  4. 单击“创建 API 密钥”按钮。

  5. 在弹出窗口中，复制显示的 API 密钥和密钥，将其保存在某个地方，然后单击“关闭”按钮。

    您将无法再次找到密钥，因此请将其保存在安全的地方！

    向用户显示的密钥

删除 API 密钥

  1. 点击您要删除的 API 密钥右侧的 “X” 图标。
  2. 确认您要为所有用户删除此 API 密钥。此操作无法撤消。单击“删除”进行确认。
    删除 API 密钥

创建 OAuth 应用程序时可以使用以下权限范围：

  • 应用程序可以读取您的配置文件信息 (OAuth2ReadPII) - 选中以允许应用程序访问您的配置文件中的信息。

  • 应用程序可以读取您的文档 (OAuth2Read) - 选中以允许应用程序读取您的文档。

  • 应用程序可以写入您的文档 (OAuth2Write) - 选中以允许应用程序对您的文档进行写入访问。

  • 应用程序可以删除您的文档和工作区 (OAuth2Delete) - 选中以允许应用程序访问删除您的文档和工作区。

  • 应用程序可以代表您请求购买 (OAuth2Purchase) - 勾选此项以允许应用程序为您进行购买。

  • 应用程序可以代表您共享和取消共享文档 (OAuth2Share) - 选中此选项可允许应用程序共享和取消共享您的文档。