跳转到内容

RealityConnect API FAQ

有些问题不属于任何单一的参考页面。它们是商业性的、架构性的,或者关于 API 不能做什么。本页收集了在支持、解决方案工程和销售沟通中最常出现的问题,往往在写下第一行代码之前就会被问到。


我可以用一套凭据访问多个组织吗?

Section titled “我可以用一套凭据访问多个组织吗?”

不可以,这是设计使然。每个 OAuth 令牌永久限定于签发时所属的组织,没有办法用一套凭据切换组织或跨组织读取数据。关于 API 能做什么、不能做什么的完整说明,请参阅简介和能力概览。

为什么我的令牌拥有所有作用域,列表却仍然为空?

Section titled “为什么我的令牌拥有所有作用域,列表却仍然为空?”

请检查内容访问权限和角色,而不是作用域。OAuth 作用域只是安全模型的第 1 层,因此即使令牌拥有所有作用域,调用账户也仍然只能看到自己拥有内容访问权限的节点,并且只能在该节点被分配的角色范围内操作。结果为空几乎总是第 2 层或第 3 层的问题,而不是缺少作用域。按任务查找 OAuth 作用域可以确认你是否拥有正确的作用域;在此基础上,再检查调用账户在该节点上的内容访问权限和角色。

使用你的访问令牌调用 GET /oauth/api-info。响应中包含你所在区域的 apiUrl 和你的 organization.id。切勿将区域 URL 硬编码。完整示例请参阅快速入门和 Client Credentials 流程。

没有 RealityTwin 许可证或 RealityPlan 席位可以使用该 API 吗?

Section titled “没有 RealityTwin 许可证或 RealityPlan 席位可以使用该 API 吗?”

大部分功能可以。RealityTwin Data Manager 许可证只会在涉及 twin 内容的调用中被消耗(资产、POI、区域、草稿、搜索、对象元数据、嵌入会话以及资产库)。用户和邀请管理、角色,以及用于发现的 /oauth/api-info 调用都不涉及任何 twin,也不会消耗许可证。部分与 RealityPlan 相关的端点还会消耗一个 RealityPlan 席位。请参阅许可。

目前没有专门的沙箱或试用环境。试用该 API 最简单的方式是在你自己的组织中创建一个 Client Credentials 应用程序。请参阅选择 OAuth 流程。

如何在 Prevu3D 对象上保留我方系统的标识符?

Section titled “如何在 Prevu3D 对象上保留我方系统的标识符?”

没有为此预留的专用字段。请在对象元数据中使用一个普通的字符串或数字属性,例如一个名为 “External IDs” 的分区,其中保存你方系统的标识符。元数据是自由形式的键/值数据,而不是固定架构,因此任何属性名都可以直接使用,无需预先配置任何内容。请参阅类型化元数据值与附件。

  • 关于 API 能读取什么、能写入什么,以及完全无法做到什么,请参阅能力概览。
  • 关于安全模型、许可以及如何选择 OAuth 流程,请参阅快速入门。
  • 浏览 API 参考以查看完整的端点目录。