集成 API
获取集成 API 连接参数
鉴权方式
HAP 组织授权开放接口为每个组织提供一套独立的密钥信息（AppKey 和 SecretKey），组织可通过此密钥信息安全调用 HAP 平台开放的各类接口，包括人员组织管理、汇报关系管理、应用管理、流程待办等数据接口。
版本
请求地址
Path 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
integrationId | string | 是 | API 集成 ID，必须属于指定组织，可通过获取 API 集成列表获取 |
Query 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
appKey | string | 是 | AppKey |
sign | string | 是 | 按组织授权签名规则生成的签名，作为查询参数传入时需进行 URL 编码 |
timestamp | integer<int64> | 是 | 时间戳（与签名所用时间戳一致，精度为毫秒） |
projectId | string | 是 | 组织编号 |
accountId | string | 是 | 操作人账号 ID |
响应参数
200HTTP 200 仍需检查业务结果；集成不存在或无权操作时返回 code=2000。响应结构 1
| 名称 | 类型 | 描述 |
|---|---|---|
success | boolean | 请求是否成功 |
data | object | — |
data.integrationId | string | API 集成 ID |
data.connectionParams | object[] | 连接参数列表，无参数时返回空数组 需要更新连接参数值时，可调用创建 API 集成导入升级任务，并设置 overwriteParams=true。 |
data.connectionParams.name | string | 参数名称 |
data.connectionParams.value | string | null | 当前参数值；隐藏参数或未设置值时返回 null。隐藏参数不返回真实值，也不返回星号脱敏占位字符串，避免调用方将脱敏内容重新写入。 |
data.connectionParams.description | string | 参数说明，无说明时返回空字符串 |
data.connectionParams.required | boolean | 是否必填 |
data.connectionParams.hidden | boolean | 是否隐藏参数值 |
data.connectionParams.hasValue | boolean | 是否已设置非空值。未设置值或已清空时 value 为 null、hasValue 为 false；隐藏参数已设置非空值时 value 为 null、hasValue 为 true。 |
响应结构 2
| 名称 | 类型 | 描述 |
|---|---|---|
code | integer | 错误码，2000 表示业务错误，400 表示连接参数校验失败，401 表示鉴权失败 |
message | string | 错误说明 |
exception | string | null | 异常信息 |
响应参数
401鉴权失败| 名称 | 类型 | 描述 |
|---|---|---|
code | integer | 错误码，2000 表示业务错误，400 表示连接参数校验失败，401 表示鉴权失败 |
message | string | 错误说明 |
exception | string | null | 异常信息 |
curl -X GET "https://example.com/integration/v1/integration/GetConnectionParams/integrationId?appKey=string&sign=string×tamp=0&projectId=string&accountId=string"{ "data": { "integrationId": "api_integration_abc123", "connectionParams": [ { "name": "client_id", "value": "example_client_id", "description": "WPS 开放平台应用 APPID（AK）", "required": true, "hidden": false, "hasValue": true }, { "name": "client_secret", "value": null, "description": "WPS 开放平台应用 APPKEY", "required": true, "hidden": true, "hasValue": true }, { "name": "base_url", "value": null, "description": "", "required": false, "hidden": false, "hasValue": false } ] }, "success": true}