## 1. 引言 随着数字化转型的不断深入，电子签名技术在企业中的应用越来越广泛。 为了满足企业对电子签名的需求，我们提供了企业签名集成API，帮助企业快速、便捷地实现电子签名功能。 本文档详细介绍了企业签名集成API的使用方法、参数说明以及注意事项，请务必仔细阅读。
## 2. API概述 ### 2.1 API功能 企业签名集成API提供以下功能： - **签名创建**：创建签名任务，支持多种签名方式，如手写签名、图片签名等。 - **签名发送**：将签名任务发送给指定的收件人。 - **签名状态查询**：查询签名任务的当前状态。
- **签名结果获取**：获取签名任务的结果，包括签名图片、签名数据等。 ### 2.2 API接口 企业签名集成API提供以下接口： - **/sign/create**：创建签名任务。 - **/sign/send**：发送签名任务。
- **/sign/status**：查询签名任务状态。 - **/sign/result**：获取签名结果。 ## 3. 使用方法 ### 3.1 初始化API 在使用企业签名集成API之前，请先进行初始化操作，获取API接口地址和密钥。
```python from enterprise_sign import EnterpriseSign # 初始化API api = EnterpriseSign(api_url='https://api.example.com', api_key='your_api_key') ``` ### 3.2 创建签名任务 创建签名任务时，需要提供以下参数： - **template_id**：模板ID，用于指定签名模板。 - **signer_list**：收件人列表，包含收件人姓名、邮箱、手机号等信息。 - **sign_type**：签名类型，如手写签名、图片签名等。
- **sign_data**：签名数据，如签名图片、签名文字等。 ```python # 创建签名任务 template_id = 'your_template_id' signer_list = [ {'name': '张三', 'email': 'zhangsan@example.com', 'phone': '13800138000'}, {'name': '李四', 'email': 'lisi@example.com', 'phone': '13900139000'} ] sign_type = 'handwritten' sign_data = '签名图片数据' task_id = api.sign.create(template_id=template_id, signer_list=signer_list, sign_type=sign_type, sign_data=sign_data) ``` ### 3.3 发送签名任务 发送签名任务时，需要提供签名任务ID。 ```python # 发送签名任务 task_id = 'your_task_id' api.sign.send(task_id=task_id) ``` ### 3.4 查询签名任务状态 查询签名任务状态时，需要提供签名任务ID。
```python # 查询签名任务状态 task_id = 'your_task_id' status = api.sign.status(task_id=task_id) print('签名任务状态：', status) ``` ### 3.5 获取签名结果 获取签名结果时，需要提供签名任务ID。 ```python # 获取签名结果 task_id = 'your_task_id' result = api.sign.result(task_id=task_id) print('签名结果：', result) ``` ## 4. 参数说明 ### 4.1 模板ID 模板ID用于指定签名模板，模板包含签名区域、签名样式等信息。 ### 4.2 收件人列表 收件人列表包含收件人姓名、邮箱、手机号等信息，用于指定签名任务的收件人。
### 4.3 签名类型 签名类型包括手写签名、图片签名等，用于指定签名方式。 ### 4.4 签名数据 签名数据包括签名图片、签名文字等，用于指定签名内容。 ## 5. 注意事项 - **API密钥安全**：请妥善保管API密钥，避免泄露。
- **签名模板**：请确保签名模板正确，避免签名失败。 - **签名任务**：请确保签名任务已发送给收件人，并等待其完成签名。 - **签名结果**：请妥善保管签名结果，避免丢失。
## 6. 常见问题 ### 6.1 如何获取API接口地址和密钥？ 请访问企业签名集成API官网，注册账号并申请API接口地址和密钥。 ### 6.2 如何创建签名模板？ 请访问企业签名集成API官网，进入模板管理页面，创建签名模板。 ### 6.3 如何处理签名失败的情况？ 请检查签名模板、签名任务参数等信息，确保无误后重新尝试。
## 7. 结束语 企业签名集成API为企业提供了便捷、高效的电子签名解决方案。 通过本文档，您已经了解了企业签名集成API的使用方法、参数说明以及注意事项。 如有疑问，请随时联系我们的技术支持。
祝您使用愉快！