iS3基础设施数字底座

# API参考

# 1. 使用前必读

iS3二次开发包提供了REST（Representational State Transfer）风格API，支持您通过HTTP请求调用，调用方法请参见 如何调用API。

同时iS3开发包还提供多种编程语言的SDK供您使用，SDK的使用方法请参见 如何调用SDK。

# 2. API概览

  • 孪生场景预览服务
API 说明
孪生场景预览服务 网页应用服务，打开浏览器输入地址即可访问
  • 孪生体服务
API 说明
查询场景中孪生体对象组 返回场景中所有的孪生对象组信息，包括孪生对象code、name等属性
查询对象组的对象实例 返回对象组中所有对象实例信息，包括对象实例的code、name等属性
查询对象组的关联子属性类型 返回对象组中所有子属性code(subCode)
查询对象组的关联子属性信息 返回对象对象组的关联子属性数据信息
  • 数据集服务
API 说明
查询项目数据字典 返回对应数据字典的元数据（时序、非时序）

# 3. 如何调用API

# 3.1 申请账号

申请iS3平台的租户和用户账号，并成功登录iS3数字在线页面 (opens new window)

# 3.2 认证鉴权

调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。

  • Token认证（动态令牌校验）：通过Token认证通用请求。适用于前端用户登录场景，是通过账号密码登录后，获取token信息，从而进行校验的方式
  • AK/SK认证（静态令牌校验）：通过AK（Access Key ID）/SK（Secret Access Key)加密调用请求。适用于分析服务和应用等后端自动访问接口的场景，可通过如下方式获取：

    • 点击右上角 AK/SK管理

    • img

    • 可以选择一个已有的，复制获得AK SK信息

    • img

    • 或点击新增，输入该令牌的名称和描述信息，新增一个访问令牌

# 3.3 调用API

见API详情

# 4. API

# 4.1 孪生场景预览服务

# 4.1.1 孪生体场景预览

  • 功能介绍

在网页预览孪生场景

  • 调试

您可以在ApiPost中调试该接口

  • URI

http://platform.is3.net.cn/#/dtScene?prjId={prjId}viewCode={viewCode}&token={token}

路径参数

无

  • 请求参数

    • 请求行

    • 参数 是否必选 参数类型 描述
      prjId 是 int 访问孪生场景所属的项目编号
      viewCode 是 string 访问孪生场景的场景编号
      token 是 string 访问所带的安全令牌

  • 响应参数

html页面

  • 请求示例

浏览器输入URL

  • 响应示例

浏览器成功显示场景

# 4.2 孪生体服务

# 4.2.1 查询场景中孪生体对象组

  • 功能介绍

返回场景中所有的孪生对象组信息

  • 调试

您可以在ApiPost中调试该接口

  • URI

https://server.is3.net.cn/is3-modules-engine/api/objs/getObjsList?prjId={prjId}

路径参数

参数 是否必选 参数类型 描述
prjId 是 int 访问孪生场景所属的项目编号

  • 请求参数

    • 请求头

    • 参数 是否必选 参数类型 描述
      X-Access-Key 是 string AK
      X-Secret-Key 是 string SK

  • 响应参数

见响应示例

  • 请求示例

GET https://server.is3.net.cn/is3-modules-engine/api/objs/getObjsList?prjId={prjId}

  • 响应示例

img

# 4.2.2 查询对象组的对象实例

  • 功能介绍

返回对象组中所有对象实例信息

  • 调试

您可以在ApiPost中调试该接口

  • URI

http://server.is3.net.cn/is3-modules-engine/api/objs/getObjsInstanceList/{objsCode}?prjId={prjId}

路径参数

参数 是否必选 参数类型 描述
objsCode 是 string 某对象组编号

  • 请求参数

    • 请求头

      • 参数 是否必选 参数类型 描述
        X-Access-Key 是 string AK
        X-Secret-Key 是 string SK

    • 请求行

    • 参数 是否必选 参数类型 描述
      prjId 是 int 访问孪生场景所属的项目编号

  • 响应参数

见响应示例

  • 请求示例

GET https://server.is3.net.cn/is3-modules-engine/api/objs/getObjsList?prjId={prjId}

  • 响应示例

img

# 4.2.3 查询对象组的关联子属性类型

  • 功能介绍

返回对象组中所有子属性code(subCode)

  • 调试

您可以在ApiPost中调试该接口

  • URI

http://server.is3.net.cn/is3-modules-engine/api/objs/getObjsSubTypeList/{objsCode}?prjId={prjId}

路径参数

参数 是否必选 参数类型 描述
objsCode 是 string 某对象组编号

  • 请求参数

    • 请求头

    • 参数 是否必选 参数类型 描述
      X-Access-Key 是 string AK
      X-Secret-Key 是 string SK

    • 请求行

    • 参数 是否必选 参数类型 描述
      prjId 是 int 访问孪生场景所属的项目编号

  • 响应参数

见响应示例

  • 请求示例
POST https://server.is3.net.cn/is3-modules-engine/api/objs/getObjsList?prjId={prjId}
  • 响应示例

img

# 4.2.4 查询对象组的关联子属性信息

  • 功能介绍

返回对应数据字典的元数据（时序、非时序）

  • 调试

您可以在ApiPost中调试该接口

  • URI

http://server.is3.net.cn/is3-modules-engine/api/objs/getObjsSubDataList/{objsCode}/{objCode}?prjId={prjId}&subMetaCode={subType}

路径参数

参数 是否必选 参数类型 描述
objsCode 是 string 某对象组编号
objCode 是 string 对象的业务编码

  • 请求参数

    • 请求头

    • 参数 是否必选 参数类型 描述
      X-Access-Key 是 string AK
      X-Secret-Key 是 string SK

    • 请求行

    • 参数 是否必选 参数类型 描述
      prjId 是 int 访问孪生场景所属的项目编号
      subMetaCode 是 string 查询的子属性类型

    • 请求体

    • 参数 是否必选 参数类型 描述
      pageSize 是 int 分页，每页的数量，若需查询所有，则写入 0
      pageSNumber 是 int 分页，返回第几页的参数，若需查询所有，则写入 0
      whereConditions 是 list 默认填写，填写筛选条件

  • 响应参数

见响应示例

  • 请求示例
POST http://server.is3.net.cn/is3-modules-engine/api/objs/getObjsSubDataList/{objsCode}/{objCode}?prjId={prjId}&subMetaCode={subType}

{
    "pageNumber": 1,
    "pageSize": 13,
    "whereConditions": []
}
  • 响应示例

img

# 4.3 数据集服务

# 4.3.1 查询项目数据字典

  • 功能介绍

返回对应数据字典的元数据（时序、非时序）

  • 调试

您可以在ApiPost中调试该接口

  • URI

http://server.is3.net.cn/data-main/operation/query/{metaTableCode}?prjId={prjId}

路径参数

参数 是否必选 参数类型 描述
metaTableCode 是 string 查询数据集的元数据编码

  • 请求参数

    • 请求头

    • 参数 是否必选 参数类型 描述
      X-Access-Key 是 string AK
      X-Secret-Key 是 string SK

    • 请求行

    • 参数 是否必选 参数类型 描述
      prjId 是 int 访问孪生场景所属的项目编号

  • 响应参数

见响应示例

  • 请求示例

POST http://server.is3.net.cn/data-main/operation/query/{metaTableCode}?prjId={prjId}

  • 响应示例

img

# 5 应用示例

暂无

# 6 附录

# 6.1 状态码

状态码 描述
200 成功
400 参数错误
500 服务端异常

← Python SDK →