文档首页/ 硬件开发工具链平台云服务/ 开发指南/ 模板卡片配置指南/ 通用外部链接卡片配置
更新时间：2024-08-07 GMT+08:00
查看PDF
分享

通用外部链接卡片配置

前提条件

已按IPDCenter外部集成开发规范完成认证逻辑。

适用场景

通用外部链接卡片适用于展示项目页面，可以通过配置不同的项目URL地址来展示不同的页面。如果需要展示多个项目页面，您可以通过配置一组项目的数据源来实现，展示时通过选择项目查看所选项目页面。

通用外部链接卡片展示效果如图1所示。

图1 通用外部链接卡片模板预览效果

配置模板卡片的配置文件

  1. 打开文本编辑工具，新建一个文件。

    您也可以在开发工具新建一个文件作为配置文件。

  2. 在文件中填写配置文件信息，配置文件的参数配置说明请参见通用外部链接卡片配置文件参数配置说明。

    配置文件格式如下： 
    {
  "label": "标签名称",
  "labelField": "${labelField1}",
  "isShowForm": true,
  "queryDataType": "api",
  "apiConfig": {
    "url": "http://www.example.com",
    "method": "GET",
    "headers": {
      "authorizationKey": "X-Pdm-Isc-Common-Token",
      "applyId": "1"
    },
    "body": {
      "params1": "value1"
    },
    "dataBody": "resp.data.data"
  },
  "iframeUrl": "${iframeUrl}"
}

  3. 将配置文件保存在本地，文件需要保存为json格式。

通用外部链接卡片配置文件参数配置说明

表1 配置项

名称

类型

默认值

说明

iframeUrl

string

''

用于配置待展示页面的完整URL地址。支持直接配置为完整的URL地址，也支持配置为数据映射来获取数据链中的某个变量。

如配置为${iframeUrl}，则会获取apiConfig配置的数据源接口的返回值中“ifreamUrl”的值。

isShowForm

Boolean

false

是否展示表单下拉框，包括如下选项：

  • 不配置
  • false
  • true

不配置或者配置值为“false”时，数据源下拉框不展示。

label

string

''

下拉框前显示的标签名称。

labelField

string

'${label}'

下拉框选项中显示的内容，必须使用数据映射方式进行自定义配置。

如配置为“${labelField1}”，界面中展示时会从接口返回值中取“labelField1”字段的值进行替换。不配置时会默认获取数据源中“label”字段的值。

apiConfig

apiConfig

--

用于配置数据源接口，具体配置请参考表2。
表2 数据源接口配置

名称

类型

默认值

说明

url

string

''

接口地址。

method

string

'GET'

接口请求方式，包括如下选项：

  • GET
  • POST
  • DELETE
  • PUT

headers

Object

{}

接口请求头配置，支持HTTP 标头配置项，同时支持机机认证逻辑。

如果配置为机机认证，需要配置机机认证信息，具体配置请参考表3。

body

Object

{}

接口参数。

dataBody

string

''

接口响应返回值中表格数据链式路径。
表3 机机认证配置

名称

类型

默认值

说明

applyId

string

--

接入机机认证机制的第三方接口对应的应用ID，用于获取token。

authorizationKey

string

--

接入机机认证机制的第三方接口自定义的请求头字段，用于携带token。

相关文档