接口描述
传入待签文本原文,使用指定账号的数字证书进行加密,如不指定账号id,则使用对接平台数字证书对文本进行加密。
接口
/v1/dataSign
请求方式
POST
请求头
提供两种安全接入方式,开发者可选择其中一种方式进行对接,对应参数如何获取,参考文档【请点击】。
方式一:请求签名鉴权(优先推荐)
请求头入参示例如下:
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
X-Tsign-Open-App-Id | string | 是 | 项目ID | |
Content-Type | string | 是 | application/json;charset=UTF-8 | |
X-Tsign-Open-Ca-Timestamp | string | 是 | API 调用者传递时间戳,值为当前时间的毫秒数,也就是从1970年1月1日起至今的时间转换为毫秒,时间戳有效时间为15分钟,为了防重放攻击 | |
Accept | string | 是 | 建议统一填写 */* | |
X-Tsign-Open-Ca-Signature | string | 是 | 签名字符串 | |
Content-MD5 | string | 否 | 当请求 Body 非 Form 表单时,可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时,加上此请求头。 | |
X-Tsign-Open-Auth-Mode | string | 是 | 选择请求方式进行鉴权,固定值,Signature |
方式二:OAuth2.0鉴权(不推荐使用)
当安全接入选择OAuth2.0鉴权方式,请点击查阅详情,请求头入参示例如下:
参数名称 | 类型 | 必选 | 参数说明 |
X-Tsign-Open-App-Id | string | 是 | 项目ID |
X-Tsign-Open-Token | string | 是 | 通过获取鉴权Token接口返回 |
Content-Type | string | 是 | application/json; charset=UTF-8 |
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 | 示例值 |
accountId | string | 否 | body | 如果是需要使用用户的数字证书进行文本签署,则需要传入用户的账号id,如不传,默认使用平台的数字证书进行文本签署。 | |
data | text | 是 | body | 待签文本 | |
type | string | 是 | body | 待签文本类型: PLATFORM,平台签 PLATFORM_USER,平台用户签 |
公共响应参数
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
code | int | 是 | 业务码,0表示成功 | |
message | string | 否 | 信息 | |
data | object | 否 | 业务信息 |
响应参数
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
signResult | text | 否 | 签署结果,请注意保存,后续可根据该参数进行验签 | |
signlogId | string | 否 | 签署记录编号,请注意保存 |
请求示例
POST https://smlopenapi.esign.cn/v1/dataSign
{ "accountId": "ca991b71dcbf461dadfdf245642697ee", "data": "测试测试", "type": "PLATFORM" }
响应示例
{ "code": 0, "message": "成功", "data": { "signlogId": "af501c01-97d8-4776-82c5-4d334b0f6666", "signResult": "VMA0GCSqGSIb3DQEBCwUAMHcxCzAJBgNVBAYMAkNOMRIwEAYDVQQIDAnmsZ/oi4/nnIExEjAQBgNVBAcMCeWNl+S6rOW4gjERMA8GA1UECgwI5pm65oWnQ0ExETAPBgNVBAsMCOaZuuaFp0NBMRowGAYDVQQDDBHmmbrmhadDQV/mtYvor5VDQTAeFw0xOTExMTgxMjMwNDFaFw0yMDExMTgxMjMwNDFaMIGIMQswCQYDVQQHDAJoejELMAkGA1UECAwCemoxCzAJBgNVBAYTAmNuMR4wHAYDVQQLDBUxMUAyMjIyMjIyMjIyMjIyMjIyMjIxPzA9BgNVBAMMNuadreW3nuWkqeiwt+S/oeaBr+enkeaKgOaciemZkOWFrOWPuO+8iOWvueaOpeS4k+eUqO+8iTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJOzx8iVB3LfbSSRUduTTh6yeisQI9Ak5qYP3bdhVD4+hy3ajOMZMV0BLhG9+FH5BuNKd4WMz5Ai8Q8em+MrWum3+Dd3BapV443qac/rg1C6BKEUDGIV5+8X2k0xxuEe8I+Q/Q/opkmX82+fxWlGJU5kEMEzho4JvYE2Z3qj3vNBQcaDPtOSrE6gmU3IeybXx9I5e3OOUpIMUdEsyNYbZhjae4l5n+VbvqMVlG7yk/9OZUWHbJMzt3a6CFK5BjqyiPmpagpbYvI+RZ1eladZRQpPmNXrTdzDAtKMVbK3K5nkSasEoALN1W1RGg9qZSorw1LODgMiD1vs0fQr7Hsa6p0CAwEAAaNdMFswDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQU9dKOW24yB2W+7JNeloosnl0iEUMwHwYDVR0jBBgwFoAUAVHiD74+5pJ0BQIe/u3cSniZDjIwCwYDVR0PBAQDAgbAMA0GCSqGSIb3DQEBCwUAA4IBAQBxdaX8frvou4qMf33w7ukqOsa7LqEWFfJVRpCG+T4PCuHpFIX6l2Ld16kKbrWpbOyTl0grf8ujFFRJI1ILuEiV8/isKcAkwtG0L0HQOiR72hINQcopW+S7MPYkeoXAJUWwMub2XRzr+Ok/f3jdSlHcX7WqposN0Xs8+8NDWZMlmV62tXJVLKy53IlIiAtNpylxTyzaAXHojJty8+Okqgf4HhLc6OFDQzte0h7AnJ+qqJ6D17zFKpm5CQMgHaEhhKM6H9bBV2pqN0QtlMD7RRBksMV1OW9Y56qpGmZ1exoC2OWhyPkgmeCSsO3B/tvQeombmuROKziIvq5gA+O2EKCHMYICHjCCAhoCAQEwgYcwdzELMAkGA1UEBgwCQ04xEjAQBgNVBAgMCeaxn+iLj+ecgTESMBAGA1UEBwwJ5Y2X5Lqs5biCMREwDwYDVQQKDAjmmbrmhadDQTERMA8GA1UECwwI5pm65oWnQ0ExGjAYBgNVBAMMEeaZuuaFp0NBX+a1i+ivlUNBAgxr3qV5tJG4kW0rXFUwDQYJYIZIAWUDBAIBBQCgaTAYBgkqhkiG9w0BCQMxCwYJKoZIhvcNAQcBMBwGCSqGSIb3DQEJBTEPFw0yMDAxMTMwODQwMTRaMC8GCSqGSIb3DQEJBDEiBCDQH7ZjG6XaDq9VL6vOlFNztepQaOtA6dQV7wC9ZIxC0DANBgkqhkiG9w0BAQEFAASCAQAT1kXnaNhe5ItzV48VJS6N21GK+gyP58aMysr/coG/QrwxkUEDcTnBzHVcpaFpJ1pi/YiUXjnfPiGhBDW2dguXgSAuO0Vb9e5bufU5w4LJ3Fm8pFQ6psZIY4yoyOgMNZdAft6yHSaEhuBJr5Sc+jAQp/AGUlNsgzcS2VyzZITWh/ISNaSeG4vbX1DcuKqEYx4bLyqzzyiauJwouz8CjG4Idtuw0LgWkmzin74pTpeL9Yl6Tq6AsOKFNGLv7m27XHpvOMy8zagR2q30wDdJq6ASDtKARXuWzhyXU9V3NrM/v5SMlY0UdpcdAA7PVcoEDT52DuwHcSNGuyODV9V3Lk3i\n" } }
错误码
错误码 | 错误描述 | 解决方案 |