快速接入

接口请求域名说明

所有的接口请求调用时需使用HTTPS协议、JSON数据格式、UTF8编码。

域名信息如下：

接口错误码说明

1. e签宝会对 message 进行文案调整，请不要根据 message 进行业务逻辑判断。
2. code 非0时均可代表业务失败或异常，开发者可使用 code 进行业务逻辑判断。
3. 接口调用出现报错时，开发者可通过错误码查询工具查找错误排查方法。

接口QPS限制说明

开发者在开放平台上创建应用时，其QPS默认值是50次/秒，即每秒最高可同时调用50次e签宝接口。

若贵司有更高的并发需求，需要付费提高QPS。QPS购买可联系客户成功经理或交付顾问。

电子签名 SaaS API 接口调用说明

请求签名鉴权方式请求头（优先推荐）

采用请求数据签名方式进行接口鉴权，防止请求数据被篡改，详见请求签名鉴权方式调用接口说明。

OAuth2.0鉴权接口调用方式（不推荐使用）

采用标准的 OAuth2.0 Client Credentials 方式进行接口鉴权，详见OAuth2.0鉴权方式调用接口说明。

请求参数类型及示例

接口请求参数分为 query、path 和 body 这三种类型。如下所示：

不同类型的请求参数具体传值方式说明如下：

1. Path类型示例

path是指请求参数需要拼接在url中即可。

举例：

请求参数accountId为path类型，接口地址为/v1/accounts/{accountId}。

例如：

https://openapi.xxx.cn/v1/accounts/229

注：例子中accountId值为229

2. Query类型示例

query是指请求的参数，一般是指URL中 ? 字符后面的参数。简单说请求时参数可以拼接在 ? 后面。

举例：请求参数thirdPartyUserId为query类型，接口地址为/v1/accounts/getByThirdId?thirdPartyUserId={accountId}

例如：

https://openapi.xxx.cn/v1/accounts/getByThirdId?thirdPartyUserId=229

注：例子中thirdPartyUserId值为229

3. Body类型示例

body是指请求体中的数据。通常情况下为接口具体入参数据的json字符串。

举例：

请求地址为

https://openapi.xxx.cn/v1/accounts/createByThirdPartyUserId

Body请求体中数据为

{
    "thirdPartyUserId":"229",
    "name":"芜浣",
    "idType":"CRED_PSN_CH_IDCARD",
    "idNumber":"xxxx",
    "mobile":"182681xxxxx",
    "email":"xxx@tsign.com"
}

则在PostMan中示例如下：

4. Path类型+Body类型示例

举例：

请求参数accountId为path类型

接口地址为/v1/accounts/{accountId}/seals/personaltemplate

请求地址为

https://openapi.xxx.cn/v1/accounts/229/seals/personaltemplate

注：例子中accountId值为229

Body请求体中数据为

{"alias": "芜浣的印章别名","color": "RED","height": 100,"type": "SQUARE","width": 100}

则在PostMan中示例如下：

5. Path类型+Query类型示例

举例：

请求参数fileId为path类型，keywords为query类型。

接口地址为/v1/documents/{fileId}/searchWordsPosition

请求地址为

https://openapi.xxx.cn/v1/documents/4c2h/searchWordsPosition?keywords=k1,k2

注：例子中fileId值为4c2h，keywords值为k1和k2。

则在PostMan中示例如下：