签署服务-预签署页面

请求参数

Header 参数

x-qys-open-accesstoken

string

可选

默认值:

x-qys-open-timestamp

string

可选

默认值:

x-qys-open-nonce

string

可选

默认值:

x-qys-open-signature

string

可选

默认值:

Body 参数application/json

contractId

string

合同ID

可选

合同ID和业务ID不能同时为空

bizId

string

业务ID

可选

合同ID和业务ID不能同时为空

tenantName

string

子公司名称

可选

若使用业务ID获取签署页面，且合同是以子公司身份创建的，则需要传递该值，用于确定合同主体

pageType

enum<string>

跳转页面类型

可选

指定签署位置页面：APPOINT，参数填写页面：FILL_PARAMETERS，基础信息编辑页面：DRAFT，默认为指定签署位置页面

枚举值:

APPOINTFILL_PARAMETERSDRAFT

callbackPage

string

跳转页面

可选

allowedSend

boolean

是否允许发起

可选

默认允许发起

hideReturnButton

boolean

是否隐藏返回按钮

可选

默认false允许显示返回按钮

lang

string

指定页面语言

可选

cn（中文）、en（英文）；默认以发起人语言为准，合同中未传发起人时，展示中文

pageStyle

object

页面风格

可选

themeColor

string

自定义页面主题色

可选

RGB颜色(16进制)，默认取业务系统令牌配置的主题色

canSaveOrClose

boolean

是否展示保存并关闭按钮

可选

默认为true展示按钮

示例

{
    "contractId": "2954298000014311991",
    "bizId": null,
 
    "callbackPage": null
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://openapi.qiyuesuo.com/v2/contract/appointurl' \
--header 'x-qys-open-accesstoken: {{x-qys-open-accesstoken}}' \
--header 'x-qys-open-timestamp: {{x-qys-open-timestamp}}' \
--header 'x-qys-open-nonce: {{x-qys-open-nonce}}' \
--header 'x-qys-open-signature: {{x-qys-open-signature}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contractId": "2954298000014311991",
    "bizId": null,
 
    "callbackPage": null
}'

返回响应

🟢200成功

application/json

Body

code

integer

可选

message

string

可选

result

object

可选

pageUrl

string

文件预签署页面

可选

链接有效期30分钟

示例

{
    "result": {
        "pageUrl": "https://cloudapi.qiyuesuo.me/contract/share/3053174206079459711?openPageToken=aadf8c25-a89d-4b21-9ab6-350dfcf31bf1&pageType=APPOINT"
    },
    "code": 0,
    "message": "SUCCESS"
}