Qiyuesuo Open Platform

https://help.qiyuesuo.com/document/open
Admin
Qiyuesuo Open Platform provides SDK and API access to digital signature, identity authentication,...
Tokens:56,256
Snippets:242
Trust Score:9.2
Update:7 months ago
Show doc for...
Tokens:
Raw
### Add Document by File (C# Example)

Source: https://help.qiyuesuo.com/document/open/detail/2740885831488119670

This C# example demonstrates initializing the SDK client and adding a document by file. It involves creating a FileStream for the document, constructing the DocumentAddByFileRequest, and handling potential exceptions during the service call. The response is then deserialized.

```csharp
//初始化sdkClient
string serverUrl = "https://openapi.qiyuesuo.cn";
string accessKey = "替换为您申请的开放平台App Token";
string accessSecret = "替换为您申请的开放平台App Secret";
SDKClient client = new SDKClient(accessKey, accessSecret,serverUrl);
string contractId = "2589012016299597907";
// 引入待添加文件
string path = "C:\Users\Richard Cheung\Documents\契约锁\测试\人事合同.pdf";
Stream file = new FileStream(path, FileMode.Open);
// 组装根据文件添加文档请求
DocumentAddByFileRequest request = new DocumentAddByFileRequest(contractId, "添加文件", file, "pdf");
string response = null;
try
{
    response = client.Service(request);
}
catch (Exception e)
{
    throw new Exception(e.Message);
}
// 解析返回结果
SdkResponse<DocumentAddResult> responseObject = HttpJsonConvert.DeserializeResponse<DocumentAddResult>(response);
if (!responseObject.Code.Equals(0))
{
    throw new Exception("请求失败，失败原因：" + responseObject.Message);
}
Console.WriteLine(“请求接口成功”);
Console.WriteLine(HttpJsonConvert.SerializeObject(responseObject));
```

--------------------------------

### Add Document by File (Go Example)

Source: https://help.qiyuesuo.com/document/open/detail/2740885831488119670

This Go example shows how to create an SDK client and add a document by file. It involves setting the contract ID, title, and file suffix, opening the file, and then making the service request. Error handling for the request is included.

```go
sdkClient := http.NewSdkClient("https://openapi.qiyuesuo.cn", "替换为您申请的开放平台App Token", "替换为您申请的开放平台App Secret")
req := request.DocumentAddByFileRequest{}
req.ContractId = "3121362688614077231"
req.Title = "goFile1"
req.FileSuffix = "pdf"
sort := 1
req.DocumentSort = &sort
file, _ := os.Open("/Users/sgf/Downloads/文件模板三.pdf")
req.File = &http.FileItem{file, ""}
response, err := sdkClient.Service(req)
if err != nil {
    fmt.Println("request failed,", err.Error())
    return
}
fmt.Println(response)
```

--------------------------------

### Add Document by File (PHP Example)

Source: https://help.qiyuesuo.com/document/open/detail/2740885831488119670

This PHP example illustrates adding a document by file using the Qiyuesuo SDK. It includes setting up the SDK client, creating a DocumentAddByFileRequest, and attaching the file using CURLFile. The result of the service call is then printed.

```php
// 初始化$sdkClient
class Util {
    const     url = "https://openapi.qiyuesuo.cn";
    const     accessKey = "替换为您申请的开放平台App Token";
    const     accessSecret = "替换为您申请的开放平台App Secret";
}
$sdkClient = Util::getSDk();
$documentAddByFileRequest = new DocumentAddByFileRequest();
$documentAddByFileRequest->setContractId('2590758386643734529');
$documentAddByFileRequest->setBizId("1111111");
$file_path = "C:/Users/QYS/Desktop/Test/444.pdf";
$file_path = iconv("UTF-8", "GBK", realpath($file_path));
$file = new \CURLFile($file_path);
$documentAddByFileRequest->setFile($file);
$documentAddByFileRequest->setFileSuffix('pdf');
$documentAddByFileRequest->setTitle('V2添加文档');
$result = $sdkClient->service($documentAddByFileRequest);
print_r($result);
return $result;
```

--------------------------------

### Add Document by File (HTTP Example)

Source: https://help.qiyuesuo.com/document/open/detail/2740885831488119670

This is an HTTP example demonstrating how to add a document by uploading a file. It includes headers for authentication and content type, along with form data for contract ID, title, file, and file suffix.

```http
POST /v2/document/addbyfile HTTP/1.1
Host: [host]
x-qys-open-timestamp: [替换为请求头生成的Timestamp]
x-qys-open-signature: [替换为请求头生成的Signature]
x-qys-open-accesstoken: [替换为请求头生成的Token]
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="contractId"
2591540368898105360
------WebKitFormBoundary7MA4YWxkTrZu0gW--
Content-Disposition: form-data; name="title"
文件文档
------WebKitFormBoundary7MA4YWxkTrZu0gW--
Content-Disposition: form-data; name="file"; filename="/C:/Users/QYS/Desktop/Test/授权.pdf
------WebKitFormBoundary7MA4YWxkTrZu0gW--
Content-Disposition: form-data; name="fileSuffix"
pdf
------WebKitFormBoundary7MA4YWxkTrZu0gW--
```

--------------------------------

### Add Document by File (Python Example)

Source: https://help.qiyuesuo.com/document/open/detail/2740885831488119670

This Python example demonstrates how to initialize the SdkClient and add a document by uploading a local file. It involves opening the file in binary read mode, setting the file, contract ID, file suffix, and title in the request object, and then making the request to the server. The response is parsed to extract the document ID.

```python
#初始化SdkClient
url = "https://openapi.qiyuesuo.cn"
accessToken = '替换为您申请的开放平台App Token'
accessSecret = '替换为您申请的开放平台App Secret'
sdkClient = SdkClient(url, accessToken, accessSecret)
documentbyfile_request = DocumentAddByFileRequest()
file = open("C:\Users\Richard Cheung\Documents\契约锁\测试\测试合同.pdf", "rb")
documentbyfile_request.set_file(file)
documentbyfile_request.set_contractId(draft_contractid)
# 将fileSuffix替换为将上传文件正确的文件类型
documentbyfile_request.set_fileSuffix('pdf')
documentbyfile_request.set_title('本地文件上传文档')
# 请求服务器
documentbyfile_response = sdkClient.request(documentbyfile_request)
# 解析返回数据
documentbyfile_mapper = json.loads(documentbyfile_response)
if documentbyfile_mapper['code'] != 0:
    raise Exception('根据本地文件添加合同文档失败，失败原因：', documentbyfile_mapper['message'])
documentbyfile_result = documentbyfile_mapper['result']
file_documentId = documentbyfile_result['documentId']
print('根据本地文件添加合同文档成功，文档ID：', file_documentId)
```

--------------------------------

### Add Document by File (Java Example)

Source: https://help.qiyuesuo.com/document/open/detail/2740885831488119670

This Java example shows how to initialize the Qiyuesuo SDK client and add a document using a file stream. It requires the server URL, access key, access secret, contract ID, file path, and file suffix. The response is parsed to log success or failure.

```java
// 初始化sdkClient
String serverUrl = "https://openapi.qiyuesuo.cn";
String accessKey = "替换为您申请的开放平台App Token";
String accessSecret = "替换为您申请的开放平台App Secret";
SdkClient sdkClient = new SdkClient(serverUrl, accessKey, accessSecret);
// 添加合同文档
DocumentAddByFileRequest request = new DocumentAddByFileRequest(contractId,
                new StreamFile(new FileInputStream("E:/test/NoSign.pdf")), "pdf", "文件一");
String response = sdkClient.service(request);
SdkResponse<DocumentAddResult> responseObj = JSONUtils.toQysResponse(response, DocumentAddResult.class);
if(responseObj.getCode() == 0) {
    DocumentAddResult result = responseObj.getResult();
    logger.info("添加合同文档成功，文档ID:{}", result.getDocumentId());
} else {
    logger.info("请求失败，错误码:{}，错误信息:{}", responseObj.getCode(), responseObj.getMessage());
}
```

--------------------------------

### Add Document by Template (Python SDK Example)

Source: https://help.qiyuesuo.com/document/open/detail/2740885975516320051

This Python example shows how to add a document from a template using the Qiyuesuo SDK. It covers initializing the SDK client, creating the `DocumentAddByTemplateRequest`, setting the title, contract ID, template ID, and template parameters before making the request.

```python
#初始化SdkClient
url = "https://openapi.qiyuesuo.cn"
accessToken = '替换为您申请的开放平台App Token'
accessSecret = '替换为您申请的开放平台App Secret'
sdkClient = SdkClient(url, accessToken, accessSecret)
documentbytemplate_request = DocumentAddByTemplateRequest()
documentbytemplate_request.set_title('模板上传文档')
documentbytemplate_request.set_contractId(draft_contractid)
documentbytemplate_request.set_templateId('2492236993899110515')
# 若模板为参数模板，设置模板中的参数值
documentbytemplate_request.set_templateParams(
    [TemplateParam('接收方1', '契约锁'), TemplateParam('接收方2', '电子合同')])
# 请求服务器
documentbytemplate_response = sdkClient.request(documentbytemplate_request)
```

--------------------------------

### GET /contract/sign-page

Source: https://help.qiyuesuo.com/document/open/detail/2593801164428415723

获取内嵌签署页面的链接，供接收方在第三方系统内完成签署。

```APIDOC
## GET /contract/sign-page

### Description
获取签署合同的嵌入式链接，支持跨域嵌入对接方的网站或APP。

### Method
GET

### Endpoint
/contract/sign-page

### Query Parameters
- **contractId** (string) - Required - 合同唯一标识ID

### Response Example
{
  "url": "https://cloud.qiyuesuo.com/sign/view?token=..."
}
```

--------------------------------

### API Request Example (HTTP)

Source: https://help.qiyuesuo.com/document/open/detail/2279605535600803840

An example of an HTTP GET request to the Qiyuesuo Open Platform API, demonstrating the required headers for authentication and request parameters. This example is useful for understanding the structure of API calls.

```HTTP
GET /v2/seal/list?selectOffset=0&selectLimit=2 HTTP/1.1
Host: openapi.qiyuesuo.cn
x-qys-open-timestamp: 1565753984643
x-qys-open-signature: 4e77af6b465c4080e25ecd012eaf2916
x-qys-open-accesstoken: DWjfxmA12a
x-qys-open-nonce: 254775d7-3c7c-4e9d-9880-1d4c5fb3dbd0
```

--------------------------------

### Add Document by Template (HTTP Request Example)

Source: https://help.qiyuesuo.com/document/open/detail/2740885975516320051

This is an example of an HTTP POST request to add a document using a template. It includes necessary headers like timestamp, signature, and access token, along with a JSON payload specifying contract details, template ID, and template parameters.

```http
POST /v2/document/addbytemplate HTTP/1.1
Host: [host]
x-qys-open-timestamp: [替换为请求头生成的Timestamp]
x-qys-open-signature: [替换为请求头生成的Signature]
x-qys-open-accesstoken: [替换为请求头生成的Token]
Content-Type: application/json
{
    "contractId": "2593815518218461185",
    "bizId": null,
    "title": "V2添加模板文档",
    "templateId": "2560778409594396776",
    "templateParams": [
        {
            "name": "乙方姓名",
            "value": "张三"
        }
    ]
}
```

--------------------------------

### Go - Contract Send API

Source: https://help.qiyuesuo.com/document/open/detail/2657157861309694607

Example of sending a contract using the Go SDK, showing how to initialize the SdkClient and make a contract send request.

```APIDOC
## POST /api/contract/send

### Description
Sends a contract using the Go SDK.

### Method
POST

### Endpoint
/api/contract/send

### Parameters
#### Request Body
- **ContractId** (string) - Required - The ID of the contract to send.

### Request Example
```go

sdkClient := http.NewSdkClient("https://openapi.qiyuesuo.cn", "YOUR_ACCESS_TOKEN", "YOUR_ACCESS_SECRET")
req := request.ContractSendRequest{}
req.ContractId = "3121737020200780306"
response, err := sdkClient.Service(req)
if err != nil {
    fmt.Println("request failed,", err.Error())
    return
}
fmt.Println(response)
```

### Response
#### Success Response (200)
- The response body will contain the result of the contract send operation.

#### Response Example
```json
{
  "message": "Contract sent successfully"
}
```

#### Error Response (Non-200)
- **error** (string) - Description of the error.

#### Error Response Example
```json
{
  "error": "Failed to send contract"
}
```
```

--------------------------------

### Python: Configure and Send Contract with Multiple Stampers

Source: https://help.qiyuesuo.com/document/open/detail/2657157861309694607

This Python example shows how to initialize the SdkClient and then define various types of stampers (company seal, legal representative seal, timestamp, personal signature) with their respective action IDs, document IDs, types, and positions. It then sends the contract using these stampers and handles the response.

```python
#初始化SdkClient
url = "https://openapi.qiyuesuo.cn"
accessToken = '替换为您申请的开放平台App Token'
accessSecret = '替换为您申请的开放平台App Secret'
sdkClient = SdkClient(url, accessToken, accessSecret)
# 设置签署位置 - 公章签署
seal_stamper = Stamper()
seal_stamper.set_actionId(company_actionId)
seal_stamper.set_documentId(file_documentId)
seal_stamper.set_type('COMPANY')
seal_stamper.set_offsetX(0.3)
seal_stamper.set_offsetY(0.5)
seal_stamper.set_page(1)
# 设置签署位置 - 法人章签署
lp_stamper = Stamper()
lp_stamper.set_actionId(lp_actionId)
lp_stamper.set_documentId(file_documentId)
lp_stamper.set_type('LP')
lp_stamper.set_offsetX(0.6)
lp_stamper.set_offsetY(0.4)
lp_stamper.set_page(1)
# 设置签署位置 - 时间戳签署
time_stamper = Stamper()
time_stamper.set_actionId(company_actionId)
time_stamper.set_documentId(file_documentId)
time_stamper.set_type('TIMESTAMP')
time_stamper.set_offsetX(0.9)
time_stamper.set_offsetY(0.5)
time_stamper.set_page(1)
# 设置签署位置 - 个人接收方 - 个人签名
personal_stamper = Stamper()
personal_stamper.set_signatoryId(personal_signatoryId)
personal_stamper.set_documentId(file_documentId)
personal_stamper.set_type('PERSONAL')
personal_stamper.set_offsetX(0.4)
personal_stamper.set_offsetY(0.7)
personal_stamper.set_page(1)
# 请求服务器
send_response = sdkClient.request(
    ContractSendRequest(draft_contractid, [seal_stamper, lp_stamper, time_stamper, personal_stamper]))
# 解析返回数据
send_mapper = json.loads(send_response)
if send_mapper['responseCode'] != '00000000':
    raise Exception('发起合同失败，失败原因：', send_mapper['message'])
print('合同发起成功')
```

--------------------------------

### Add Document by Template (Java SDK Example)

Source: https://help.qiyuesuo.com/document/open/detail/2740885975516320051

This Java code demonstrates how to add a document using a template with the Qiyuesuo SDK. It initializes the SDK client, creates a request object with contract and template details, sets template parameters, sends the request, and processes the response.

```java
// 初始化sdkClient
String serverUrl = "https://openapi.qiyuesuo.cn";
String accessKey = "替换为您申请的开放平台App Token";
String accessSecret = "替换为您申请的开放平台App Secret";
SdkClient sdkClient = new SdkClient(serverUrl, accessKey, accessSecret);
// 添加合同文档
List<TemplateParam> params = new ArrayList<>();
params.add(new TemplateParam("param1", "val1"));
params.add(new TemplateParam("param2", "val2"));
DocumentAddByTemplateRequest request = new DocumentAddByTemplateRequest(contractId, 
        templateId, params, "文件二");
String response = sdkClient.service(request);
SdkResponse<DocumentAddResult> responseObj = JSONUtils.toQysResponse(response, DocumentAddResult.class);
if(responseObj.getCode() == 0) {
    DocumentAddResult result = responseObj.getResult();
    logger.info("添加合同文档成功，文档ID:{}", result.getDocumentId());
} else {
    logger.info("请求失败，错误码:{}，错误信息:{}", responseObj.getCode(), responseObj.getMessage());
}
```

--------------------------------

### Add Document by Template (PHP SDK Example)

Source: https://help.qiyuesuo.com/document/open/detail/2740885975516320051

This PHP code snippet illustrates adding a document via a template using the Qiyuesuo SDK. It includes initializing the SDK client, setting contract and template IDs, defining template parameters, and making the service request.

```php
// 初始化$sdkClient
class Util {
    const     url = "https://openapi.qiyuesuo.cn";
    const     accessKey = "替换为您申请的开放平台App Token";
    const     accessSecret = "替换为您申请的开放平台App Secret";
}
$sdkClient = Util::getSDk();
$documentAddByTemplateRequest = new DocumentAddByTemplateRequest();
$documentAddByTemplateRequest->setContractId('2590758386643734529');
$documentAddByTemplateRequest->setBizId("1111111");
$documentAddByTemplateRequest->setTitle('V2添加模板文档');
$documentAddByTemplateRequest->setTemplateId('2558597440364655396');
/**填写模板参数**/
$templateParam1 = new TemplateParam();
$templateParam1->setName("乙方姓名");
$templateParam1->setValue("张三");
$templateParams = array();
array_push($templateParams, $templateParam1);
$documentAddByTemplateRequest->setTemplateParams($templateParams);
$result = $sdkClient->service($documentAddByTemplateRequest);
print_r($result);
return $result;
```

--------------------------------

### Add Document by Template (C# SDK Example)

Source: https://help.qiyuesuo.com/document/open/detail/2740885975516320051

This C# code shows how to use the Qiyuesuo SDK to add a document from a template. It involves initializing the SDK client, constructing the `DocumentAddByTemplateRequest`, adding template parameters, sending the request, and handling potential exceptions and response parsing.

```csharp
string serverUrl = "https://openapi.qiyuesuo.cn";
string accessKey = "替换为您申请的开放平台App Token";
string accessSecret = "替换为您申请的开放平台App Secret";
SDKClient client = new SDKClient(accessKey, accessSecret, serverUrl);
string contractId = "2589012016299597907";
string templateId = "2562841550577214123";
// 组装根据模板创建文档请求
DocumentAddByTemplateRequest request = new DocumentAddByTemplateRequest(contractId, "添加模板", templateId);
// 设置模板参数内容
request.AddTemplateParam(new TemplateParam("Sender", "契约锁"));
request.AddTemplateParam(new TemplateParam("Reciver1", "开放平台"));
request.AddTemplateParam(new TemplateParam("Reciver2", "对接方公司"));
string response = null;
try
{
    response = client.Service(request);
}
catch (Exception e)
{
    throw new Exception(e.Message);
}
// 解析返回内容
SdkResponse<DocumentAddResult> responseObject = HttpJsonConvert.DeserializeResponse<DocumentAddResult>(response);
if (!responseObject.Code.Equals(0))
{
    throw new Exception("请求失败，失败原因：" + responseObject.Message);
}
Console.WriteLine("请求接口成功");
Console.WriteLine(HttpJsonConvert.SerializeObject(responseObject));
```

--------------------------------

### Python - Contract Send API

Source: https://help.qiyuesuo.com/document/open/detail/2657157861309694607

Example of sending a contract using the Python SDK, demonstrating the initialization of SdkClient and the creation of different stamper types (company seal, legal representative seal, timestamp, personal signature).

```APIDOC
## POST /api/contract/send

### Description
Sends a contract with specified stampers and configurations using the Python SDK.

### Method
POST

### Endpoint
/api/contract/send

### Parameters
#### Request Body
- **draft_contractid** (string) - Required - The ID of the draft contract.
- **stampers** (list) - Required - A list of Stamper objects, each defining a signature or seal position.
  - **actionId** (string) - Required - The ID of the action associated with the stamper.
  - **documentId** (string) - Required - The ID of the document.
  - **type** (string) - Required - The type of stamper (e.g., 'COMPANY', 'LP', 'TIMESTAMP', 'PERSONAL').
  - **offsetX** (float) - Required - The horizontal offset for the stamper.
  - **offsetY** (float) - Required - The vertical offset for the stamper.
  - **page** (integer) - Required - The page number where the stamper should be placed.
  - **signatoryId** (string) - Optional - The ID of the signatory for PERSONAL type stampers.

### Request Example
```python
# Initialize SdkClient
url = "https://openapi.qiyuesuo.cn"
accessToken = 'YOUR_ACCESS_TOKEN'
accessSecret = 'YOUR_ACCESS_SECRET'
sdkClient = SdkClient(url, accessToken, accessSecret)

# Set signature position - Company Seal
seal_stamper = Stamper()
seal_stamper.set_actionId(company_actionId)
seal_stamper.set_documentId(file_documentId)
seal_stamper.set_type('COMPANY')
seal_stamper.set_offsetX(0.3)
seal_stamper.set_offsetY(0.5)
seal_stamper.set_page(1)

# Set signature position - Legal Representative Seal
lp_stamper = Stamper()
lp_stamper.set_actionId(lp_actionId)
lp_stamper.set_documentId(file_documentId)
lp_stamper.set_type('LP')
lp_stamper.set_offsetX(0.6)
lp_stamper.set_offsetY(0.4)
lp_stamper.set_page(1)

# Set signature position - Timestamp
time_stamper = Stamper()
time_stamper.set_actionId(company_actionId)
time_stamper.set_documentId(file_documentId)
time_stamper.set_type('TIMESTAMP')
time_stamper.set_offsetX(0.9)
time_stamper.set_offsetY(0.5)
time_stamper.set_page(1)

# Set signature position - Personal Recipient - Personal Signature
personal_stamper = Stamper()
personal_stamper.set_signatoryId(personal_signatoryId)
personal_stamper.set_documentId(file_documentId)
personal_stamper.set_type('PERSONAL')
personal_stamper.set_offsetX(0.4)
personal_stamper.set_offsetY(0.7)
personal_stamper.set_page(1)

# Request server
send_response = sdkClient.request(
    ContractSendRequest(draft_contractid, [seal_stamper, lp_stamper, time_stamper, personal_stamper]))

# Parse return data
send_mapper = json.loads(send_response)
if send_mapper['responseCode'] != '00000000':
    raise Exception('Failed to initiate contract, reason:', send_mapper['message'])
print('Contract initiated successfully')
```

### Response
#### Success Response (200)
- **responseCode** (string) - Indicates success ('00000000').
- **message** (string) - Success message.

#### Response Example
```json
{
  "responseCode": "00000000",
  "message": "Contract initiated successfully"
}
```

#### Error Response (Non-200)
- **responseCode** (string) - Error code.
- **message** (string) - Error message.

#### Error Response Example
```json
{
  "responseCode": "XXXXXXX",
  "message": "Error details"
}
```
```

--------------------------------

### GET /v2/company/fee/info

Source: https://help.qiyuesuo.com/document/open/detail/2725986623018775399

查询当前企业的费用使用情况及余额信息。

```APIDOC
## GET /v2/company/fee/info

### Description
获取企业账户的费用信息。

### Method
GET

### Endpoint
/v2/company/fee/info

### Response
#### Success Response (200)
- **balance** (number) - 账户余额
- **usage** (object) - 费用使用详情
```

--------------------------------

### Go: Initialize SDK Client and Send Contract Request

Source: https://help.qiyuesuo.com/document/open/detail/2657157861309694607

This Go snippet shows how to initialize the SdkClient with API credentials and then create a ContractSendRequest. It demonstrates making a service call to send the contract and handling potential errors.

```go
sdkClient := http.NewSdkClient("https://openapi.qiyuesuo.cn", "替换为您申请的开放平台App Token", "替换为您申请的开放平台App Secret")
req := request.ContractSendRequest{}
req.ContractId = "3121737020200780306"
response, err := sdkClient.Service(req)
if err != nil {
    fmt.Println("request failed,", err.Error())
    return
}
fmt.Println(response)
```

--------------------------------

### GET /open/ssogateway

Source: https://help.qiyuesuo.com/document/open/detail/2805340005688414924

发起单点登录请求，通过 ticket 凭证验证用户身份并重定向至契约锁平台指定页面。

```APIDOC
## GET /open/ssogateway

### Description
该接口用于单点登录（SSO），通过传入的 ticket 凭证验证身份，并根据 pageType 参数跳转至对应的业务页面。

### Method
GET

### Endpoint
/open/ssogateway

### Parameters
#### Query Parameters
- **ticket** (string) - Required - 单点登录请求凭证（UUID），一次性验证。
- **pageType** (string) - Optional - 目标页面类型（如 INDEX_PAGE, CONTRACT_LIST_PAGE 等）。
- **companyId** (string) - Optional - 指定的公司ID，用于以特定公司员工身份登录。
- **contractId** (string) - Optional - 合同ID，仅在 CONTRACT_DETAIL_PAGE 时生效。
- **signReturnUrl** (string) - Optional - 签署完成后的跳转链接。
- **hideSidebar** (bool) - Optional - 是否隐藏侧边栏。
- **hideSideBarOnly** (bool) - Optional - 是否仅隐藏侧边栏（不含顶栏）。
- **hideTopBarOnly** (bool) - Optional - 是否仅隐藏顶栏。
- **hideDraftBtn** (bool) - Optional - 是否隐藏【签发文件】按钮。

### Request Example
https://cloudapi.qiyuesuo.com/open/ssogateway?ticket=uuid-example-123&pageType=CONTRACT_LIST_PAGE

### Response
#### Success Response (302)
- 重定向至目标业务页面。

#### Error Response (302)
- 重定向至配置的登录页面，并携带 code 和 service 参数。

#### Error Codes
- **100**: 非平台方请求，Referer 验证失败。
- **102**: Ticket 验证失败。
- **201**: 无效的公司ID。
- **202**: 用户非指定公司员工。
- **203**: 不支持的页面操作。
- **204**: 无效的合同ID。
```

--------------------------------

### Create Contract Draft with Company and Personal Signatories (Go)

Source: https://help.qiyuesuo.com/document/open/detail/2657157684079370591

This Go snippet demonstrates creating a contract draft using the Qiyuesuo SDK. It shows how to initialize the SDK client with credentials, define contract details including creator and category, and set up multiple signatories (company and personal). The code also includes adding template parameters and specifying whether to send the contract immediately, followed by making the API request and printing the response.

```go
sdkClient := http.NewSdkClient("https://openapi.qiyuesuo.cn", "替换为您申请的开放平台App Token", "替换为您申请的开放平台App Secret")
contract := model.Contract{}
contract.Subject = "go测试合同-08"
user := model.User{}
user.Name = "宋一"
user.Contact = "10000000011"
user.ContactType = "MOBILE"
contract.Creator = &user
category := model.Category{}
category.Name = "平台-个人-预设流程"
contract.Category = &category

signatory1 := model.Signatory{}
signatory1.TenantName = "测试11-8-1"
signatory1.TenantType = "COMPANY"
signatory1.Receiver = &user
signatory1SerialNo := 1
signatory1.SerialNo = &signatory1SerialNo

signatory2 := model.Signatory{}
signatory2.TenantName = "宋一"
signatory2.TenantType = "PERSONAL"
//delaySet := true
//signatory2.DelaySet = &delaySet
receiver := model.User{}
receiver.Name = "宋一"
receiver.Contact = "10000000011"
receiver.ContactType = "MOBILE"
signatory2.Receiver = &receiver
signatory2SerialNo := 2
signatory2.SerialNo = &signatory2SerialNo

var signatories []*model.Signatory
signatories = append(signatories, &signatory1)
signatories = append(signatories, &signatory2)
contract.Signatories = signatories

var templateParams []*model.TemplateParam
param1 := model.TemplateParam{}
param1.Name = "param1"
param1.Value = "v1"
param2 := model.TemplateParam{}
param2.Name = "param2"
param2.Value = "v2"
templateParams = append(templateParams, ¶m1)
templateParams = append(templateParams, ¶m2)
contract.TemplateParams = templateParams

send := false
contract.Send = &send

req := request.ContractDraftRequest{}
req.Contract = &contract

response, err := sdkClient.Service(req)
if err != nil {
    fmt.Println("request failed,", err.Error())
    return
}
fmt.Println(response)
```

--------------------------------

### Handle URL Scheme for App Redirection

Source: https://help.qiyuesuo.com/document/open/detail/3091925715390829267

Intercepts specific URL schemes in Android WebView to launch the Qiyuesuo app or redirect to the application market if not installed.

```Java
@Override
public boolean shouldOverrideUrlLoading(WebView view, String url) {
	Uri uri = Uri.parse(url);
	if("qys".equals(uri.getScheme())){
		try {
			Intent intent = new Intent(Intent.ACTION_VIEW, uri);
			intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
			startActivity(intent);
		} catch (Exception e) {
			e.printStackTrace();
			Uri downloadApkUri = Uri.parse("market://details?id=com.genyannetwork.qiyuesuo");
			Intent intent = new Intent(Intent.ACTION_VIEW, downloadApkUri);
			intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
			startActivity(intent);
		}
		return true;
	}
	return super.shouldOverrideUrlLoading(view, url);
}
```

--------------------------------

### PHP - Contract Send API

Source: https://help.qiyuesuo.com/document/open/detail/2657157861309694607

Example of sending a contract using the PHP SDK, including setting up various stampers (company seal, legal representative seal, timestamp, personal signature) and sending the request.

```APIDOC
## POST /api/contract/send

### Description
Sends a contract with specified stampers and configurations.

### Method
POST

### Endpoint
/api/contract/send

### Parameters
#### Request Body
- **stampers** (array) - Required - An array of Stamper objects, each defining a signature or seal position.
  - **actionId** (string) - Required - The ID of the action associated with the stamper.
  - **documentId** (string) - Required - The ID of the document.
  - **sealId** (string) - Optional - The ID of the seal to be used.
  - **page** (integer) - Required - The page number where the stamper should be placed.
  - **offsetX** (string) - Required - The horizontal offset for the stamper.
  - **offsetY** (string) - Required - The vertical offset for the stamper.
  - **type** (string) - Optional - The type of stamper (e.g., 'COMPANY', 'LP', 'TIMESTAMP', 'PERSONAL').
  - **signatoryId** (string) - Optional - The ID of the signatory for PERSONAL type stampers.

### Request Example
```php
$stamper2 = new Stamper();
$stamper2->setActionId('2590758390800289796');
$stamper2->setDocumentId('2590762507098624044');
$stamper2->setSealId('2555244623418466517');
$stamper2->setPage('1');
$stamper2->setOffsetX('0.5');
$stamper2->setOffsetY('0.5');
$stampers = array();
array_push($stampers, $stamper1);
array_push($stampers, $stamper2);
$contractSendRequest->setStampers($stampers);
$result = $sdkClient->service($contractSendRequest);
print_r($result);
return $result;
```

### Response
#### Success Response (200)
- **responseCode** (string) - Indicates success ('00000000').
- **message** (string) - Success message.

#### Response Example
```json
{
  "responseCode": "00000000",
  "message": "Contract sent successfully"
}
```

#### Error Response (Non-200)
- **responseCode** (string) - Error code.
- **message** (string) - Error message.

#### Error Response Example
```json
{
  "responseCode": "XXXXXXX",
  "message": "Error details"
}
```
```

--------------------------------

### 初始化SdkClient并进行用户认证请求 (Python)

Source: https://help.qiyuesuo.com/document/open/detail/2772301936651674391

此代码演示了如何使用契约锁SDK初始化SdkClient，并构建一个用户认证请求。它设置了API的URL、访问令牌和密钥，然后配置了用户认证的模式、修改字段、证件类型以及用户的联系方式。最后，发送请求并打印响应。

```python
from qiyuesuo_openapi_sdk.client import SdkClient
from qiyuesuo_openapi_sdk.models.request.user_auth_miniapp_ticket_request import UserAuthMiniappTicketRequest
from qiyuesuo_openapi_sdk.models.user import User

url = "https://openapi.qiyuesuo.cn"
accessToken = '替换为您申请的开放平台App Token'
accessSecret = '替换为您申请的开放平台App Secret'
sdkClient = SdkClient(url, accessToken, accessSecret)

request = UserAuthMiniappTicketRequest()
request.set_mode("DEFAULT")
modifyFields = []
modifyFields.append("USERNAME")
request.set_modifyFields(modifyFields)
request.set_paperType("IDCARD")

user = User()
user.set_contact("151****64046497")
user.set_contactType("MOBILE")
request.set_user(user)

response = sdkClient.request(request)
print(str(response))
```

--------------------------------

### Initialize SdkClient and Request Company Authentication

Source: https://help.qiyuesuo.com/document/open/detail/2772302148338201564

This snippet demonstrates how to instantiate the SdkClient with credentials and execute a company authentication request. It requires the Qiyuesuo SDK and specific company applicant details to return an authentication response.

```python
url = "https://openapi.qiyuesuo.cn"
accessToken = '替换为您申请的开放平台App Token'
accessSecret = '替换为您申请的开放平台App Secret'
sdkClient = SdkClient(url, accessToken, accessSecret)
request = CompanyAuthMiniappTicketRequest()
request.set_companyName("HZK测试企业-111")
applicant = User("HZK", "151****6497", "MOBILE")
request.set_applicant(applicant)
auth_h5_page_response = sdkClient.request(request)
print(auth_h5_page_response)
```

--------------------------------

### Create Contract Draft with Company and Personal Signatories (Python)

Source: https://help.qiyuesuo.com/document/open/detail/2657157684079370591

This Python snippet demonstrates how to create a contract draft using the Qiyuesuo SDK. It shows setting up a company signatory with audit, company seal, and legal representative seal actions, and a personal signatory with attachment requirements. The code also includes setting the contract's expiration time and disabling immediate sending before making the API request.

```python
company_signatory = Signatory()
company_signatory.set_tenantType("COMPANY")
company_signatory.set_tenantName("测试公司")
company_signatory.set_serialNo(1)
company_receiver = User()
company_receiver.set_contact("10100000000")
company_receiver.set_contactType("MOBILE")
company_signatory.set_receiver(company_receiver)

# 设置对接方公司签署流程 - 审批流程，并设置审批人
audit_action = Action()
audit_action.set_type("AUDIT")
audit_action.set_serialNo(1)
audit_operator = User()
audit_operator.set_contact("10100000000")
audit_operator.set_contactType("MOBILE")
audit_action.set_operators([audit_operator])

# 设置对接方公司签署流程 - 公章签署流程，并设置该流程应该签署的公章
seal_action = Action()
seal_action.set_type("COMPANY")
seal_action.set_serialNo(2)
seal_action.set_sealId("2490828768980361630")

# 设置对接方公司签署流程 - 法人章签署流程
lp_action = Action()
lp_action.set_type("LP")
lp_action.set_serialNo(3)
company_signatory.set_actions([audit_action, seal_action, lp_action])

# 设置签署方 - 个人签署方，并设置附件上传要求
personal_signatory = Signatory()
personal_signatory.set_tenantType("PERSONAL")
personal_signatory.set_serialNo(2)
personal_signatory.set_tenantName("个人接收方姓名")
personal_receiver = User()
personal_receiver.set_contact("10100000000")
personal_receiver.set_contactType("MOBILE")
personal_signatory.set_receiver(personal_receiver)

# 生成上传附件要求
personal_attachment = Attachment()
personal_attachment.set_title("附件-身份证正面照")
personal_attachment.set_required(True)
personal_signatory.set_attachments([personal_attachment])

draft_contract.set_signatories([company_signatory, personal_signatory])

# 设置合同截止签署时间
draft_contract.set_expireTime("2019-07-28 23:59:59")

# 不发起合同
draft_contract.set_send(False)

# 请求服务器
draft_response = sdkClient.request(ContractDraftRequest(draft_contract))

# 解析返回数据
draft_mapper = json.loads(draft_response)
if draft_mapper['responseCode'] != '00000000':
    raise Exception("创建合同草稿失败，失败原因：", draft_mapper['message'])
draft_result = draft_mapper['result']
draft_contractid = draft_result['id']
print('创建合同草稿成功，合同ID：', draft_contractid)
```

--------------------------------

### Create Contract Draft (Go)

Source: https://help.qiyuesuo.com/document/open/detail/2657157684079370591

This snippet shows how to create a contract draft using the Go SDK, configuring contract subject, creator, category, signatories, and template parameters.

```APIDOC
## POST /contracts/draft

### Description
Creates a draft of a contract using the Go SDK, specifying contract details like subject, creator, category, signatories, and template parameters.

### Method
POST

### Endpoint
/contracts/draft

### Parameters
#### Request Body
- **Contract** (Object) - Required - The contract object containing all details.
  - **Subject** (String) - Required - The subject or title of the contract.
  - **Creator** (User) - Required - Information about the contract creator.
    - **Name** (String) - Optional - Name of the user.
    - **Contact** (String) - Required - Contact identifier.
    - **ContactType** (String) - Required - Type of contact (e.g., "MOBILE").
  - **Category** (Category) - Required - The category of the contract.
    - **Name** (String) - Required - Name of the category (e.g., "平台-个人-预设流程").
  - **Signatories** (Array[Signatory]) - Required - A list of signatories for the contract.
    - **TenantName** (String) - Required - The name of the tenant.
    - **TenantType** (String) - Required - The type of tenant (e.g., "COMPANY", "PERSONAL").
    - **Receiver** (User) - Required - Information about the receiver.
      - **Name** (String) - Optional - Name of the receiver.
      - **Contact** (String) - Required - Contact identifier.
      - **ContactType** (String) - Required - Type of contact.
    - **SerialNo** (Integer) - Required - The sequence number for the signatory.
    - **DelaySet** (Boolean) - Optional - Flag to delay setting for the signatory.
  - **TemplateParams** (Array[TemplateParam]) - Optional - Parameters for the contract template.
    - **Name** (String) - Required - Name of the parameter.
    - **Value** (String) - Required - Value of the parameter.
  - **Send** (Boolean) - Optional - Whether to send the contract immediately after creation.

### Request Example
```go
sdkClient := http.NewSdkClient("https://openapi.qiyuesuo.cn", "替换为您申请的开放平台App Token", "替换为您申请的开放平台App Secret")
contract := model.Contract{}
contract.Subject = "go测试合同-08"
user := model.User{}
user.Name = "宋一"
user.Contact = "10000000011"
user.ContactType = "MOBILE"
contract.Creator = &user
category := model.Category{}
category.Name = "平台-个人-预设流程"
contract.Category = &category
signatory1 := model.Signatory{}
signatory1.TenantName = "测试11-8-1"
signatory1.TenantType = "COMPANY"
signatory1.Receiver = &user
signatory1SerialNo := 1
signatory1.SerialNo = &signatory1SerialNo
signatory2 := model.Signatory{}
signatory2.TenantName = "宋一"
signatory2.TenantType = "PERSONAL"
receiver := model.User{}
receiver.Name = "宋一"
receiver.Contact = "10000000011"
receiver.ContactType = "MOBILE"
signatory2.Receiver = &receiver
signatory2SerialNo := 2
signatory2.SerialNo = &signatory2SerialNo
var signatories []*model.Signatory
signatories = append(signatories, &signatory1)
signatories = append(signatories, &signatory2)
contract.Signatories = signatories
var templateParams []*model.TemplateParam
param1 := model.TemplateParam{}
param1.Name = "param1"
param1.Value = "v1"
param2 := model.TemplateParam{}
param2.Name = "param2"
param2.Value = "v2"
templateParams = append(templateParams, ¶m1)
templateParams = append(templateParams, ¶m2)
contract.TemplateParams = templateParams
send := false
contract.Send = &send
req := request.ContractDraftRequest{}
req.Contract = &contract
response, err := sdkClient.Service(req)
if err != nil {
    fmt.Println("request failed,", err.Error())
    return
}
fmt.Println(response)
```

### Response
#### Success Response (200)
- **responseCode** (String) - Response code indicating success.
- **message** (String) - Success message.
- **result** (Object) - The result of the operation, containing contract details.
  - **id** (String) - The unique identifier of the created contract draft.

#### Response Example
```json
{
  "responseCode": "00000000",
  "message": "操作成功",
  "result": {
    "id": "contract_draft_id_12345"
  }
}
```

### Error Handling
- **11011102**: Duplicate signatory.
- **11990005**: Invalid parameters (format error, missing required parameters, out of range, incorrect type).
- **11041701**: Employee not found.
- **11041801**: Company does not exist.
- **11041702**: Employee has resigned.
- **14990002**: Permission mismatch.
- **21990001**: Internal error.
- **11011151**: No permission to initiate this business category.
```
Tokens:
Raw