集成 API
导入生成集成 API
鉴权方式
HAP 组织授权开放接口为每个组织提供一套独立的密钥信息（AppKey 和 SecretKey），组织可通过此密钥信息安全调用 HAP 平台开放的各类接口，包括人员组织管理、汇报关系管理、应用管理、流程待办等数据接口。
版本
请求地址
Query 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
appKey | string | 是 | AppKey |
sign | string | 是 | 按组织授权签名规则生成的签名，作为查询参数传入时需进行 URL 编码 |
timestamp | integer<int64> | 是 | 时间戳（与签名所用时间戳一致，精度为毫秒） |
projectId | string | 是 | 组织编号 |
accountId | string | 是 | 操作人账号 ID |
Body 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
operatorId | string | 是 | 操作人 ID |
mediaId | string | 是 | 已上传的 API 集成文件 ID |
connectionParams | object[] | 否 | 需要设置的连接参数值，按名称匹配文件中的参数。参数名称、说明、必填和隐藏属性由导入文件定义，本字段用于设置参数值。
|
connectionParams.name | string | 是 | 连接参数名称，区分大小写 |
connectionParams.value | string | 是 | 连接参数值。不接受 null；空字符串表示明确置空。 |
响应参数
200成功，返回导入生成的 API 集成 ID。HTTP 200 不一定表示业务成功；请求校验失败时返回 status=2、data 信息列表及 msg。响应结构 1
| 名称 | 类型 | 描述 |
|---|---|---|
success | boolean | 请求是否成功 |
data | object | — |
data.integrationId | string | 新生成的 API 集成 ID，可用于获取集成 API 连接参数或创建导入升级任务 |
响应结构 2
| 名称 | 类型 | 描述 |
|---|---|---|
status | integer | 校验状态，2 表示数据校验失败 可选值： 2 |
data | string[] | 校验失败信息列表 |
msg | string | 状态说明 |
响应参数
400连接参数校验失败。value 不接受 null。| 名称 | 类型 | 描述 |
|---|---|---|
code | integer | 错误码，2000 表示业务错误，400 表示连接参数校验失败，401 表示鉴权失败 |
message | string | 错误说明 |
exception | string | null | 异常信息 |
响应参数
401鉴权失败| 名称 | 类型 | 描述 |
|---|---|---|
code | integer | 错误码，2000 表示业务错误，400 表示连接参数校验失败，401 表示鉴权失败 |
message | string | 错误说明 |
exception | string | null | 异常信息 |
curl -X POST "https://example.com/integration/v1/integration/Import?appKey=string&sign=string×tamp=0&projectId=string&accountId=string" \ -H "Content-Type: application/json" \ -d '{ "operatorId": "user_123", "mediaId": "file_111", "connectionParams": [ { "name": "client_id", "value": "example_client_id" }, { "name": "client_secret", "value": "example_client_secret" } ] }'{ "data": { "integrationId": "api_integration_abc123" }, "success": true}