电子签名云API | Python SDK

浏览我们的产品

Are you looking for an evaluation version of a product?

If so you can download any of the below versions for testing. The product will function as normal except for an evaluation limitation. At the time of purchase we provide a license file via email that will allow the product to work in its full capacity. If you would also like an evaluation license to test without any restrictions for 30 days, please follow the directions provided here.

Are you having troubles in downloading?

If you experience errors, when you try to download a file, make sure your network policies (enforced by your company or ISP) allow downloading ZIP and/or MSI files.

安装
该软件包在PyPI可用，可以通过执行以下命令通过pip安装：
pip install groupdocs-signature-cloud

要求

Python 2.7 或 3.4+
pip 包管理器
GroupDocs Cloud 凭证 — 来自仪表板的 Client ID 和 Client Secret

依赖关系

SDK自动安装以下软件包：

Package	Constraint
urllib3	>= 1.15
six	>= 1.10
certifi	—
python-dateutil	—

快速入门

获取您的 API 凭证

要使用GroupDocs.Signature Cloud，请在GroupDocs.Cloud仪表板注册并获取您的Client ID和Client Secret。

初始化API

使用以下代码开始使用GroupDocs.Signature Cloud SDK for Python：

import groupdocs_signature_cloud

# Get your ClientId and ClientSecret at https://dashboard.groupdocs.cloud
client_id = "YourClientId"
client_secret = "YourClientSecret"

# Create API configuration
configuration = groupdocs_signature_cloud.Configuration(client_id, client_secret)
configuration.api_base_url = "https://api.groupdocs.cloud"

# Create instance of the Sign API
sign_api = groupdocs_signature_cloud.SignApi.from_config(configuration)

使用文本签名签署文档

初始化后，使用此基本示例将文本签名添加到 Word 文档：

import groupdocs_signature_cloud

client_id = "YourClientId"
client_secret = "YourClientSecret"

sign_api = groupdocs_signature_cloud.SignApi.from_keys(client_id, client_secret)

file_info = groupdocs_signature_cloud.FileInfo()
file_info.file_path = "signaturedocs/one-page.docx"

opts = groupdocs_signature_cloud.SignTextOptions()
opts.signature_type = "Text"
opts.text = "GroupDocs.Signature Cloud"
opts.left = 100
opts.top = 100
opts.width = 100
opts.height = 100
opts.page = 1

settings = groupdocs_signature_cloud.SignSettings()
settings.options = [opts]
settings.file_info = file_info
settings.save_options = groupdocs_signature_cloud.SaveOptions()
settings.save_options.output_file_path = "signaturedocs/signedTextOne_page.docx"

request = groupdocs_signature_cloud.CreateSignaturesRequest(settings)
response = sign_api.create_signatures(request)

print("Succeeded count: " + str(len(response.succeeded)))

通过本快速入门指南，您已准备好开始在 Python 应用程序中使用 GroupDocs.Signature Cloud 签署文档。欲了解更多详情，请访问文档。

获取支持的文件格式

通过签名 API 检索可用的受支持文件格式的完整列表。

import groupdocs_signature_cloud

info_api = groupdocs_signature_cloud.InfoApi.from_keys("YourClientId", "YourClientSecret")

result = info_api.get_supported_file_formats()

for fmt in result.formats:
    print(fmt.file_format)

使用数字签名签署文档

将数字证书应用于文档以进行安全、防篡改的签名。

import groupdocs_signature_cloud

sign_api = groupdocs_signature_cloud.SignApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_signature_cloud.FileInfo()
file_info.file_path = "signaturedocs/one-page.docx"

opts = groupdocs_signature_cloud.SignDigitalOptions()
opts.signature_type = "Digital"
opts.image_file_path = "signaturedocs/signature.jpg"
opts.certificate_file_path = "signaturedocs/temp.pfx"
opts.password = "1234567890"
opts.left = 100
opts.top = 100
opts.width = 200
opts.height = 100
opts.page = 1

settings = groupdocs_signature_cloud.SignSettings()
settings.options = [opts]
settings.file_info = file_info
settings.save_options = groupdocs_signature_cloud.SaveOptions()
settings.save_options.output_file_path = "signaturedocs/signedDigitalOne_page.docx"

request = groupdocs_signature_cloud.CreateSignaturesRequest(settings)
response = sign_api.create_signatures(request)

print("Succeeded count: " + str(len(response.succeeded)))

搜索条形码签名

在签名文档中搜索条形码签名并检索匹配的签名详细信息。

import groupdocs_signature_cloud

sign_api = groupdocs_signature_cloud.SignApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_signature_cloud.FileInfo()
file_info.file_path = "signaturedocs/signedBarcodeOne_page.docx"

opts = groupdocs_signature_cloud.SearchBarcodeOptions()
opts.signature_type = "Barcode"
opts.page = 1

settings = groupdocs_signature_cloud.SearchSettings()
settings.options = [opts]
settings.file_info = file_info

request = groupdocs_signature_cloud.SearchSignaturesRequest(settings)
response = sign_api.search_signatures(request)

print("Signatures found: " + str(len(response.signatures)))

验证文本签名

验证签名文档中是否存在具有预期内容的文本签名。

import groupdocs_signature_cloud

sign_api = groupdocs_signature_cloud.SignApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_signature_cloud.FileInfo()
file_info.file_path = "signaturedocs/signedTextOne_page.docx"

opts = groupdocs_signature_cloud.VerifyTextOptions()
opts.signature_type = "Text"
opts.text = "GroupDocs.Signature Cloud"
opts.match_type = "Contains"
opts.page = 1

settings = groupdocs_signature_cloud.VerifySettings()
settings.options = [opts]
settings.file_info = file_info

request = groupdocs_signature_cloud.VerifySignaturesRequest(settings)
response = sign_api.verify_signatures(request)

print("IsSuccess: " + str(response.is_success))

使用条形码签名签署文档

将条形码签名添加到具有可自定义外观和编码的文档中。

import groupdocs_signature_cloud

sign_api = groupdocs_signature_cloud.SignApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_signature_cloud.FileInfo()
file_info.file_path = "signaturedocs/one-page.docx"

opts = groupdocs_signature_cloud.SignBarcodeOptions()
opts.signature_type = "Barcode"
opts.text = "123456789012"
opts.barcode_type = "Code128"
opts.left = 100
opts.top = 100
opts.width = 300
opts.height = 100
opts.page = 1

settings = groupdocs_signature_cloud.SignSettings()
settings.options = [opts]
settings.file_info = file_info
settings.save_options = groupdocs_signature_cloud.SaveOptions()
settings.save_options.output_file_path = "signaturedocs/signedBarcodeOne_page.docx"

request = groupdocs_signature_cloud.CreateSignaturesRequest(settings)
response = sign_api.create_signatures(request)

print("Succeeded count: " + str(len(response.succeeded)))

GitHub 上的示例项目

GroupDocs.Signature Cloud Python 示例存储库包含可立即运行的示例，涵盖：

Category	Examples
Basic Usage	Supported formats, supported barcodes, supported QR codes, document info, document preview, file and folder operations
Advanced Usage — Sign	Text, image, barcode, QR-code, digital, stamp, and collection signatures
Advanced Usage — Search	Search text, barcode, QR-code, and digital signatures
Advanced Usage — Verify	Verify text, barcode, QR-code, and digital signatures
Advanced Usage — Update	Update barcode and QR-code signatures
Advanced Usage — Delete	Delete barcode and QR-code signatures

如何运行示例

克隆或下载示例存储库
编辑RunExamples.py并设置client_id和client_secret 3.进入Examples目录 4.运行pip install groupdocs-signature-cloud -U 5.执行python RunExamples.py