企业官网建设流程全解析

LibreSign API集成指南：连接其他系统的强大能力

【免费下载链接】libresignControl how your documents get signed项目地址: https://gitcode.com/gh_mirrors/li/libresign

LibreSign是一款强大的文档签名管理工具，通过其API接口，你可以轻松将文档签名功能集成到各种系统中，实现文档签署流程的自动化和高效化。本指南将详细介绍LibreSign API的核心功能、认证方式、常用接口以及实际集成示例，帮助你快速掌握API集成技巧。

一、API概览：核心功能与优势

LibreSign API基于OpenAPI 3.0规范设计，提供了丰富的接口用于管理文档签名流程。通过API，你可以实现以下核心功能：

• 文档管理：上传、验证、删除文档，创建文档信封
• 签名请求：创建、更新、取消签名请求，管理签署人
• 签名操作：签署文档，获取签署状态，管理签名元素
• 策略管理：配置签署策略，设置签署流程规则

图：LibreSign API功能架构示意图，展示了主要接口模块及其关系

二、快速上手：API认证与基础请求

2.1 认证方式

LibreSign API支持两种认证方式：

• Basic Auth：使用用户名和密码进行认证
• Bearer Token：使用访问令牌进行认证

示例请求头：

Authorization: Basic dXNlcjE6cGFzc3dvcmQ=

或

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

2.2 API基础路径

所有API端点都基于以下基础路径：

/ocs/v2.php/apps/libresign/api/v1/

2.3 响应格式

API响应采用统一的OCS格式，包含元数据和实际数据：

{ "ocs": { "meta": { "status": "ok", "statuscode": 200, "message": "OK" }, "data": { // 实际响应数据 } } }

三、核心接口实战：从文档上传到完成签署

3.1 上传文档

使用POST /file接口上传文档：

curl -X POST https://your-nextcloud.com/ocs/v2.php/apps/libresign/api/v1/file \ -H "Authorization: Bearer {token}" \ -H "OCS-APIRequest: true" \ -H "Content-Type: application/json" \ -d '{ "file": { "base64": "base64-encoded-file-content", "name": "document.pdf" } }'

响应将返回文档ID和元数据，用于后续操作。

3.2 创建签名请求

使用POST /request-signature接口创建签名请求：

curl -X POST https://your-nextcloud.com/ocs/v2.php/apps/libresign/api/v1/request-signature \ -H "Authorization: Bearer {token}" \ -H "OCS-APIRequest: true" \ -H "Content-Type: application/json" \ -d '{ "fileId": 123, "signers": [ { "identifyMethods": [ { "method": "email", "value": "signer@example.com", "requirement": "required" } ], "displayName": "John Doe", "signingOrder": 1 } ], "signatureFlow": "ordered_numeric" }'

图：通过API创建签名请求后，签署人收到的签名请求界面

3.3 签署文档

签署人可以使用POST /sign/uuid/{uuid}接口签署文档：

curl -X POST https://your-nextcloud.com/ocs/v2.php/apps/libresign/api/v1/sign/uuid/{uuid} \ -H "OCS-APIRequest: true" \ -H "Content-Type: application/json" \ -d '{ "method": "emailToken", "token": "received-token", "elements": { "signature": { "type": "draw", "data": "base64-encoded-signature" } } }'

3.4 查询签署状态

使用GET /file/validate/uuid/{uuid}接口查询文档签署状态：

curl -X GET https://your-nextcloud.com/ocs/v2.php/apps/libresign/api/v1/file/validate/uuid/{uuid} \ -H "Authorization: Bearer {token}" \ -H "OCS-APIRequest: true"

响应将包含文档的当前状态、签署人列表及其签署状态。

四、高级应用：策略控制与批量操作

4.1 策略管理

LibreSign API允许你通过/policies接口管理签署策略，例如设置签名流程、要求身份验证等：

curl -X PUT https://your-nextcloud.com/ocs/v2.php/apps/libresign/api/v1/policies/group/{groupId}/signature_flow \ -H "Authorization: Bearer {token}" \ -H "OCS-APIRequest: true" \ -H "Content-Type: application/json" \ -d '{ "value": "ordered_numeric", "allowChildOverride": false }'

4.2 批量操作

通过/file/list接口可以批量获取文档列表，支持分页和过滤：

curl -X GET "https://your-nextcloud.com/ocs/v2.php/apps/libresign/api/v1/file/list?page=1&length=20&status[]=1&status[]=2" \ -H "Authorization: Bearer {token}" \ -H "OCS-APIRequest: true"

五、集成最佳实践

5.1 错误处理

API调用可能返回各种错误，建议在代码中妥善处理：

try { const response = await fetch(apiUrl, { method: 'POST', headers, body }); const data = await response.json(); if (data.ocs.meta.status !== 'ok') { throw new Error(data.ocs.meta.message); } return data.ocs.data; } catch (error) { console.error('API Error:', error.message); // 处理错误，如重试、通知用户等 }

5.2 异步处理

对于耗时操作（如大量文档签署），建议使用异步处理：

curl -X POST https://your-nextcloud.com/ocs/v2.php/apps/libresign/api/v1/sign/file_id/{fileId} \ -H "Authorization: Bearer {token}" \ -H "OCS-APIRequest: true" \ -H "Content-Type: application/json" \ -d '{ "method": "emailToken", "async": true }'

然后通过/file/progress/{uuid}接口查询进度。

5.3 安全考虑

• 始终使用HTTPS加密传输
• 定期轮换访问令牌
• 限制API权限范围
• 验证所有输入数据

六、总结与资源

LibreSign API为系统集成提供了强大而灵活的能力，通过本文介绍的接口和最佳实践，你可以轻松实现文档签名功能的自动化。更多详细接口定义，请参考项目中的openapi.json文件。

如需进一步开发，可以参考以下资源：

• 项目源码：lib/Controller/
• 测试用例：tests/php/Api/
• 前端组件：src/components/Signers/

通过LibreSign API，你可以将文档签署功能无缝集成到CRM、ERP、HR系统等各类应用中，大幅提升工作效率和文档处理安全性。

【免费下载链接】libresignControl how your documents get signed项目地址: https://gitcode.com/gh_mirrors/li/libresign