竹云IDaaS•开放平台
员工身份(EIAM)

协议配置

协议配置接口调用过程中，根据配置返回不同结果。正常调用成功会返回协议配置信息，没有配置协议，返回空数组。

# 请求说明

GET https://{your_domain}/api/v2/sdk/agreement-config

# 请求头

参数名 中文名称 必须 类型 示例
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
content-type 内容格式类型 是 String application/json

# 返回示例

成功示例：
HTTP/1.1 200 OK
Content-Type: application/json
{
    "code": "0",
    "data": [
        {
            "id": "20231213172230071-656B-DC5398451",
            "text": {
                "en": {
                    "context": "I have read and agree to the {20231214153403735-0EB3-72CE8BDC0} and {20231214153403729-2452-986A407AA}",
                    "agreements": [
                        {
                            "id": "20231214153403735-0EB3-72CE8BDC0",
                            "name": "23",
                            "type": "URL",
                            "context": "https://XXX"
                        },
                        {
                            "id": "20231214153403729-2452-986A407AA",
                            "name": "12",
                            "type": "URL",
                            "context": "https://XXX"
                        }
                    ]
                },
                "zh": {
                    "context": "我已阅读并同意{20231214153403717-76A1-31234B44F}和{20231214153403713-DA60-2201131A6}",
                    "agreements": [
                        {
                            "id": "20231214153403717-76A1-31234B44F",
                            "name": "2",
                            "type": "URL",
                            "context": "https://XXX"
                        },
                        {
                            "id": "20231214153403713-DA60-2201131A6",
                            "name": "1",
                            "type": "URL",
                            "context": "https://XXX"
                        }
                    ]
                }
            }
        }
    ],
    "message": null
}

错误示例：
无
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

# 返回参数data为协议配置列表，列表参数内容：

参数名 中文名称 类型
id 协议配置id String
text 协议配置中协议正文 Object
text.context 协议正文中内容 String
text.agreements 协议正文中协议 Object
text.agreements.id 协议id String
text.agreements.name 协议名称 String
text.agreements.type 协议类型 String
text.agreements.context 协议类型对应内容 String

# 错误码

状态码 错误码 错误信息 处理措施
400 IDAAS.SDK.PARAM.0001 Device information is incomplete 请检查输入的设备信息是否完整
设备信息不完整

协议签署