RealityConnect API (RCAPI)
简介 Prevu3D RealityConnect API 概览:功能、区域架构、OAuth2 身份验证,以及它如何融入 RealityPlatform 和 RealityTwin 集成。
快速入门 RealityConnect API 的前提条件、网络访问以及安全模型。选择一种 OAuth 流程并遵循其专属指南。
你的第一次修改,从头到尾 一段可以直接复制粘贴的 Client Credentials 实践:获取令牌,浏览到某个站点并重命名,在 Prevu3D Platform 中查看变化,然后撤销。
OAuth 作用域参考 RealityConnect API 授予的每一个 OAuth 作用域及其授权范围,以及新集成常遇到的注意事项。
搜索 Business Object 和节点 通过 RealityConnect API 搜索孪生体内部的 business object 与元数据,或搜索你组织的节点层级结构。
OAuth 流程 Client Credentials 流程、Native Application 流程、Authorization Code + 自定义重定向流程
速率限制 RealityConnect API 的速率限制桶、响应标头,以及如何处理 429 Too Many Requests。
错误代码 RealityConnect API 各操作返回的命名错误代码参考,按端点分组,包含响应结构和每种代码的建议处理方式。
contextId 接受哪些值 RealityConnect API 的 twin 和 RealityPlan 路由中,路径参数 contextId 接受哪些类型的 id,以及为何一个有效的 id 仍会返回 404。
令牌生命周期实践 如何在长时间运行的集成中安全地缓存和刷新 RealityConnect API OAuth 令牌:各流程的真实 TTL,以及什么会提前使令牌失效。
凭据管理 如何安全地存储、轮换和吊销 RealityConnect API 的 OAuth 凭据,以及泄露的访问令牌可能触及的范围。
删除究竟做了什么(按资源划分) RealityConnect API 中删除每种资源实际行为的参考:哪些删除可恢复、什么会阻止删除、遗留引用会发生什么。
节点类型与层级结构 RealityConnect API 的 10 种节点类型、有效的父子组合、API 可创建的类型,以及 DataNode 的结构。
API 稳定性、版本管理与弃用 RealityConnect API 如何标记实验性操作、什么算作破坏性变更,以及弃用政策。
POI 图标参考(textureId) 创建兴趣点(POI)时可用的全部有效 textureId 值,以及每个图标实际呈现的内容。
查找您的 ID:组织、节点和上下文 了解如何获取组织 ID、遍历 RealityConnect API 的节点树,以及每个路由系列所需的 ID(contextId、organizationId)。
共享分段上传参考 RealityConnect API 上传端点共享的发起、上传、完成模式,包括 partNumber 与 startIndex 的分段编号规则。
类型化元数据值与附件 RealityConnect API 元数据属性值参考:string/number/boolean/标记对象的联合类型、external-link 与 attachment 哨兵类型,以及附件的上传、下载与删除流程。
节点缩略图 上传、获取和移除数据节点的缩略图图片,以及 includeThumbnail 和 thumbnailSignedUrl 在 browse 和 search 中的行为。
网络要求 从企业网络访问 RealityConnect API 所需的防火墙、代理、TLS 和出站(egress)要求,以及分步连接诊断流程。
RealityConnect API FAQ “关于 RealityConnect API 的商业、架构以及”我能不能这样做”类问题的解答,这些问题往往在项目获批之前就已出现。”