HTTP/HTTPS
请求协议
OAPI接口服务市场 / OpenAPI / 电子合同模板上传
电子合同模板上传
接口地址:https://www.oapi.cc/store/App.Esign.UploadTemplate
接口描述: 此接口与模板填充接口配合使用,接入方预先将制作好的PDF模板通过此接口上传到平台,后续如需要签署合同时只需要将需填充的内容通过模板填充接口传入,即可生成合同供签署操作,请参考“合同签署(引用模板)”流程。
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 必须 | - | 访问令牌,生成令牌可使用App.Auth.ApplyToken接口 | |
doc_url | 字符串 | 必须 | - | 文档地址 |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.template_id | 字符串 | 平台返回的电子合同模板编号,后续签署合同需要 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 必须 | |
doc_url | 必须 |
客户端请求示例
# 暂无示例,可添加示例文件:./src/view/docs/demos/App.Esign.UploadTemplate.json
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
500 | 表示服务端内部错误 |
本文档生成时间:2025-05-04 23:11:22