功能入口
位置:租户端 - 总览
地址:console.{工业环境域名}/overview
功能说明
总览模块用于显示不同模块下一些用户数据的汇总信息,比如:应用-使用中、待支付、将到期,协同制造需求-招标中、接标中等等。
第三方接入时有的产品需要在总览展示各自模块的数据信息,本文档主要说明服务商如何接入。
准备工作
服务商需提供接入接口,工业云将服务商需要展示模块注册进来,数据展示部分通过注册进来的URL后端调用,包装后返给前端。
提供接口URL需具备以下条件:注册的接口支持在请求头Cookie中传入access_token。
- 服务商需要接入工业云平台账号系统。
- 实现数据统计接口,按照接口规范返回接口数据。
接口开发
接口要求
项目 | 说明 |
---|---|
传输协议 | HTTP 传输协议 |
接口请求⽅式 | GET⽅法提交 |
请求头支持传access_token | 工业云侧请求接口时会在cookie上携带access_token,服务商获取到access_token后,解析出账号信息,从而查询出需要展示的统计数据返回。 |
结果返回标准 | 需按照接口规范进行结果返回。具体见下文返回参数部分。 |
数据统计接口
接口URL
请求参数说明
请求头需支持传access_token。工业云侧请求接口时会在cookie上携带access_token,服务商获取到access_token后,解析出账号信息,从而查询出需要展示的统计数据返回。
响应参数说明
字段名 | 字段类型 | 字段描述 |
---|---|---|
Code | integer | 返回码 0成功 其他失败 |
Msg | string | 错误信息 |
DataDisplays.Key | string | 统计信息名称 |
DataDisplays.Value | string | 统计信息数目 |
DataDisplays.Info | string | 统计信息数目说明 |
Contents.Title | string | 列表标题 |
Contents.Values.Name | string | 列表内容 |
Contents.Values.Value | string | 列表值(id/url) |