契约锁 API

合同管理-浏览页面

GET

/v2/contract/viewurl

请求参数

Query 参数

contractId

string

可选

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

示例值:

2954298000014311991

bizId

string

可选

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

documentId

string

可选

文档ID，指定浏览页面默认打开的文档

tenantName

string

可选

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

lang

string

可选

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

themeColor

string

可选

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

Header 参数

x-qys-open-accesstoken

string

可选

默认值:

x-qys-open-timestamp

string

可选

默认值:

x-qys-open-nonce

string

可选

默认值:

x-qys-open-signature

string

可选

默认值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://openapi.qiyuesuo.com/v2/contract/viewurl' \
--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}}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

result

object

必需

pageUrl

string

合同浏览页面

必需

链接有效期30分钟

示例

{
  "result": {
    "pageUrl": "https://cloudapi.qiyuesuo.me/contract/share/3053227767890968697?openPageToken=8a7384fb-9f63-4f27-8a2d-661a33653cd1"
  },
  "code": 0,
  "message": "SUCCESS"
}

合同管理-添加签署方

合同管理-合同详情