--- title: "OnShape Connector" slug: "onshape-connector" updated: 2023-11-03T16:53:46Z published: 2023-11-03T16:53:46Z canonical: "support.tulip.co/onshape-connector" --- > ## Documentation Index > Fetch the complete documentation index at: https://support.tulip.co/llms.txt > Use this file to discover all available pages before exploring further. # OnShape 连接器 ## OnShape 连接器 *将 Tulip 与 OnShape 集成* [Embedded content](https://www.youtube.com/embed/YWWTtRKjjE0) ## 简介 Onshape的REST API允许用户与Onshape进行交互,但用户必须在各自的Onshape账户中设置正确的访问权限。本连接器的目标是使用 HTTP 连接器将 Tulip 与 Onshape 集成,并为客户提供可导入其实例的开箱即用连接器。 ## 目的 我们将重点介绍不同的连接器功能,这些功能可通过 HTTP 调用 Onshape REST API 与 Onshape 系统进行交互,从而展示 Onshape 上的各种读写操作,这些操作可用于各种用例。 ## API 文档 [Onshape API 概述](https://onshape-public.github.io/docs/apioverview/ ## 验证) ## 前提条件 1. 在 Onshape 上创建账户并配置 OAuth2 凭证。 2. 在 Onshape 中使用所需的作用域注册 API。 ## 郁金香连接详细信息 需要在 Tulip 的 连接器。 1. 运行于:云连接器主机 2. 主机:cad.onshape.com 3. 端口:443 4. TLS: 是 OAuth 2:身份验证将转发到所有 连接器功能 ## 连接器功能 #### 获取所有文件 **目的** 此连接器将获取用户 Onshape 工作区中的所有文档。 **端点** `HTTP GET 调用端点:https://cad.onshape.com:443/api/documents` **所需输入** 无需输入 **所需输出提取器** 1. 文档 ID:文档的唯一标识符,用于执行其他任务。 2. 文档名称:文档的显示名称。 3. 工作区 ID:用于执行其他任务的文档工作区的唯一标识符。 4. 随响应返回的其他参数将作为输出参数的一部分。 #### 获取特定文档的所有元素 **目的** 该连接器将通过传递所需的输入来获取特定文档的所有元素。 **端点** `HTTP GET 调用端点:https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements` **所需输入** 要传递的 URL 参数如下 1. 文档 ID 2. 工作区 ID **所需输出提取器** 1. 元素 ID:用于执行其他任务的元素的唯一标识符。 2. 元素名称:元素的显示名称。 3. 元素类型:元素的类型。 4. 随响应返回的其他参数将作为输出参数的一部分。 #### 获取元素属性 **用途** 该连接器将获取文档中特定元素类型部分的所有元素属性。 **端点** `HTTP GET 调用端点:https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements?elementType={ElementType}&elementId={ElementID}。` **必要输入** 以下是需要传递的 URL 参数 1. 文档 ID 2. 工作区 ID 3. 元素 ID 4. 元素类型 #### **必需的输出提取器** 1. 元素 ID:用于执行其他任务的元素的唯一标识符。 2. 元素名称:元素的显示名称。 3. 元素类型:元素的类型。 4. 随响应返回的附加参数将作为输出参数的一部分。 #### 获取部件工作室主体详细信息 **用途** 该连接器将通过传递所需的输入,获取特定文档中 Part Studio 元素的所有主体详细信息。 **端点** `HTTP GET 调用端点:https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bodydetails` **所需输入** 要传递的 URL 参数如下 1. 文档 ID 2. 工作区 ID 3. 元素 ID **所需输出提取器** 1. 正文 ID:用于执行其他任务的主体的唯一标识符。 2. 主体类型:部件正文类型。 3. 随响应返回的附加参数将作为输出参数的一部分。 #### 获取部件工作室边框 **目的** 该连接器将通过传递所需的输入,获取特定文档中 Part Studio 元素的所有边框。 **端点** `HTTP GET 调用端点:https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes` **所需输入** 以下是需要传递的 URL 参数 1. 文档 ID 2. 工作区 ID 3. 元素 ID **所需输出提取器** 1. 低 X:lowX 的值。 2. Low Y: lowY 的值。 3. 低 Z: lowZ 的值。 4. 高 X:HighX 的值。 5. High Y: highY 的值。 6. High Z: highZ 的值。 #### 获取单个部件的元数据 **用途** 该连接器将通过所需的输入,获取特定文档中 Part Studio 元素的单个部分的元数据。 **端点** `HTTP GET 调用端点:https://cad.onshape.com:443/api/metadata/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/p/{PartID}。` **所需输入** 以下是需要传递的 URL 参数 1. 文档 ID 2. 工作区 ID 3. 元素 ID 4. 部件 ID **所需的输出提取器** 1. 部件 ID:用于执行其他任务的部件的唯一标识符。 2. 部件类型:部件类型。 3. 随响应返回的附加参数将作为输出参数的一部分。 #### 获取装配体定义 **目的** 该连接器将通过传递所需的输入,获取特定文档中装配元素的装配定义。 **端点** `HTTP GET 调用端点:https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}。` **所需输入** 要传递的 URL 参数如下 1. 文档 ID 2. 工作区 ID 3. 元素 ID #### **所需输出提取器** 1. 实例 ID: 用于执行其他任务的实例的唯一标识符。 2. 实例名称:实例名称。 3. 随响应返回的附加参数将作为输出参数的一部分。 #### 获取装配体的边框 **用途** 此连接器将通过传递所需的输入,获取特定文档中装配元素的所有边框。 #### **端点** `HTTP GET 调用端点:https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes` #### **所需输入** 以下是需要传递的 URL 参数 1. 文档 ID 2. 工作区 ID 3. 元素 ID #### **所需输出提取器** 1. 低 X:lowX 的值。 2. Low Y: lowY 的值。 3. 低 Z: lowZ 的值。 4. 高 X:HighX 的值。 5. High Y: highY 的值。 6. High Z: highZ 的值。 #### 获取装配物料清单 **目的** 该连接器将通过传递所需的输入,获取特定文档中装配元素的物料清单。 **端点** `HTTP GET 调用端点 https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bom` #### **所需输入** 要传递的 URL 参数如下 1. 文档 ID 2. 工作区 ID 3. 元素 ID #### **所需输出提取器** 1. 物料清单 ID:物料清单表的唯一标识符。 2. 物料清单名称:物料清单表名称。 3. 物料清单类型:物料清单表类型。 4. 随响应返回的其他参数作为输出参数的一部分。