员工身份(EIAM)
协议签署
协议签署接口调用过程中，根据协议配置中的协议id，签署协议，如果用户已经签署过同一协议同一版本，则不会再签署。
# 请求说明
POST https://{your_domain}/api/v2/sdk/agreement/sign
# 请求头
| 参数名 | 中文名称 | 必须 | 类型 | 示例 |
|---|---|---|---|---|
| X-operating-sys-version | 调用方客户端操作系统版本 | 是 | String | windows10.1.1 |
| X-device-fingerprint | 调用方客户端设备指纹 | 是 | String | 156aysdna213sc50 |
| X-device-ip | 调用方客户端IP | 否 | String | 192.168.1.2 |
| X-agent | User-Agent信息 | 是 | String | Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X) |
| X-L | 用于国际化语言设置 | 否 | String | zh |
| X-client-id | 应用授权ID | 是 | String | nTo1eRIub60vPb54WeE6aojPwYwImtl4 |
| Authorization | 授权信息 | 是 | String | Bearer {id_token} |
| content-type | 内容格式类型 | 是 | String | application/json |
# 请求示例
{
"agreements": [
"D8924F7071DC1D29A6822C794D848D9C",
"DDS24F7071DC1D29A6822C794D848A1C"
],
"scene":"LOGIN"
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# 请求参数
| 参数名 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| agreementIds | 用户协议id集合 | 是 | List | |
| scene | 签署场景 | 是 | String | 支持LOGIN,REGISTER |
# 返回示例
成功示例：
HTTP/1.1 200 OK
Content-Type: application/json
错误示例：
HTTP/1.1 400 Bad Request
{
"code": "ECS.AGREEMENT.0001",
"data": null,
"message": "用户协议不存在"
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# 错误码
| 状态码 | 错误码 | 错误信息 | 处理措施 |
|---|---|---|---|
| 400 | ECS.AGREEMENT.0001 | Agreement Id not exist | 请检查输入的设备信息是否完整 |
| 协议id不存在 | |||
| 400 | SDK.COMMON.1003 | Device information is incomplete | 请检查输入的设备信息是否完整 |
| 设备信息不完整 | |||
| 400 | IDAAS.SDK.PARAM.0016 | IdToken is invalid or expired | 请重新获取IdToken后再试 |
| IdToken无效或已过期 | |||
| 400 | IDAAS.SDK.COMMON.1001 | Parameter {0} cannot be left blank | |
| 参数 {0} 不能为空 |