创建导入处方单个人印章
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
本接口(CreatePreparedPersonalEsign)用于创建导入个人印章(处方单场景专用,使用此接口请与客户经理确认)。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreatePreparedPersonalEsign。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
UserName | 是 | String | 个人用户姓名 |
IdCardNumber | 是 | String | 证件号码,应符合以下规则
|
SealName | 是 | String | 印章名称,长度1-50个字。 |
Operator | 否 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
IdCardType | 否 | String | 证件类型,支持以下类型
|
SealImageCompress | 否 | Boolean | 是否开启印章图片压缩处理,默认不开启,如需开启请设置为 true。当印章超过 2M 时建议开启,开启后图片的 hash 将发生变化。 |
Mobile | 否 | String | 手机号码;当需要开通自动签时,该参数必传 |
EnableAutoSign | 否 | Boolean | 此字段已废弃,请勿继续使用。 |
SealColor | 否 | String | 印章颜色(参数ProcessSeal=true时生效) 默认值:BLACK黑色 取值: BLACK 黑色, RED 红色, BLUE 蓝色。 示例值:BLACK |
ProcessSeal | 否 | Boolean | 是否处理印章,默认不做印章处理。 取值如下:
示例值:false |
FileId | 否 | String | 印章图片文件 id 取值: 填写的FileId通过UploadFiles接口上传文件获取。 |
Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 |
LicenseType | 否 | Integer | 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次 1-不绑定,发起合同时将按标准合同套餐进行扣减 |
SceneKey | 否 | String | 自动签使用的场景值, 可以选择的场景值如下:
注: 不传默认为处方单场景,即E_PRESCRIPTION_AUTO_SIGN 示例值:E_PRESCRIPTION_AUTO_SIGN |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SealId | String | 导入生成的印章ID,为32位字符串。 建议开发者保存此印章ID,开头实名认证后,通过此 ID查询导入的印章。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 通过准备好的印章图片创建个人印章
通过准备好的印章图片创建个人印章
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePreparedPersonalEsign
<公共请求参数>
{
"Operator": {
"UserId": "abc"
},
"UserName": "印章归属个人姓名",
"IdCardType": "",
"IdCardNumber": "身份证件号码",
"FileId": "yDxdfffxxxxxxxx",
"SealName": "我的印章名称",
"Mobile": "135*111",
"EnableAutoSign": true
}
输出示例
{
"Response": {
"SealId": "sealid-1",
"RequestId": "abc"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.IdCardNumberCheckFailed | 身份信息校验不通过,请确认后重试。 |
FailedOperation.LicenseNoQuota | 当前无可用的许可 |
InvalidParameter.CardNumber | 不合法的证件信息,请检查证件号证件类型是否正确。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidMobile | 无效的手机号 |
OperationDenied.InvalidApproverAge | 签署人年龄限制无法使用电子签服务。 |