Установка

Пакет доступен в PyPI, и его можно установить через pip, выполнив следующую команду:

pip install groupdocs-signature-cloud

Требования

• Python 2.7 или 3.4+
• менеджер пакетов pip
• Учетные данные GroupDocs Cloud — Client ID и Client Secret из панели управления

Зависимости

SDK автоматически устанавливает следующие пакеты:

Python Cloud REST API для электронной подписи документов

GroupDocs.Signature Cloud SDK для Python предоставляет комплексное решение для интеграции электронных подписей в веб-приложения, сценарии и рабочие процессы автоматизации Python. Он поддерживает широкий спектр типов подписей — текст, изображение, штрих-код, QR-код, цифровую подпись и штамп — в форматах Word, Excel, PDF, презентаций и изображений. Разработчики могут настраивать внешний вид, размещение и безопасность подписи, применять цифровые сертификаты, проверять подлинность подписи и искать существующие подписи в документах. Независимо от того, подписываете ли вы одну страницу или управляете несколькими подписями в коллекции документов, GroupDocs.Signature предоставляет надежные инструменты для безопасного и эффективного подписания документов в облаке.

Функции подписи облачных документов

Применение подписей к определенным страницам - Применяйте подписи на четных, нечетных или определенных страницах для точного размещения.
Настройка заполнения страницы - Установите отступы для точного выравнивания подписей на каждой странице.
Настройка внешнего вида подписи - Управляйте шрифтами, цветами и стилем подписей.
Применить настройки обрезки фона - Используйте настройки обрезки фона, чтобы улучшить видимость подписи.
Повторить строку подписи - Повторяйте строки подписи, чтобы заполнить определенные области.
Цифровые подписи с помощью CryptoApi и XmlDsig - Поддержка цифровых подписей через CryptoApi и XmlDsig.
Выравнивание текста для подписей со штрих-кодом - Выравнивайте подписи штрих-кодов, используя настраиваемый текст.
Подписание документов, защищенных паролем - Подписывайте документы, защищенные паролем.
Проверка подписей документов - Проверить подлинность и действительность подписей документов.
Поиск типов подписей - Поиск определенных типов подписей в документах.

Расширенные функции

Настройка внешнего вида подписи - Настраивайте шрифты, цвета и стиль подписи.
Управление несколькими подписями - Обработка нескольких подписей в одном документе.
Защита паролем для документов - Добавьте защиту паролем к подписанным документам.
Проверьте подлинность подписи - Проверить подлинность нанесенных подписей.
Поиск конкретных подписей - Поиск текста, штрих-кода, QR-кода и цифровых подписей.
Обновление и удаление подписей - Измените или удалите существующие подписи из документов.

Подписи со штрих-кодом и QR-кодом

Поддерживаемые форматы штрих-кодов и QR-подписей - Поддерживает форматы DOC, DOCX, XLSX, PDF и изображений.
Настройка подписей в виде штрих-кода/QR-кода - Настраивайте внешний вид и содержание штрих-кодов/QR-подписей.
Сценарии использования штрих-кода/QR-кода - Варианты использования включают отслеживание и идентификацию документов.

Штампы-подписи

Обзор подписей штампами - Визуальные и текстовые подписи для официальных документов.
Настройка подписей штампов - Настройте размер, текст и внешний вид штампа.

Поддерживаемые типы подписей

Текстовая подпись - Добавляйте настраиваемые текстовые метки с указанием шрифта, цвета и выравнивания.
Подпись изображения - Применяйте подписи изображений с непрозрачностью, оттенками серого, яркостью и контрастностью.
Подпись со штрих-кодом - Добавляйте типы штрих-кодов с гибким внешним видом, выравниванием и кодировкой.
Подпись QR-кода - Вставляйте подписи QR-кода с настраиваемой кодировкой и внешним видом.
Цифровая подпись - Применяйте цифровые сертификаты (PFX, CRT) к документам или страницам PDF.
Штамп-подпись - Размещайте изображения штампов на страницах с возможностью гибкой настройки.

Операции с файлами

Загрузить файлы в облако - Загружайте файлы в облачное хранилище через API.
Загрузить файлы из облака - Загружайте файлы из облачного хранилища в локальные системы.
Копировать файлы - Копируйте файлы из облачного хранилища в разные места.
Переместить файлы - Перемещайте файлы между папками в облачном хранилище.
Удалить файлы - Удалите определенные файлы из облачного хранилища.

Операции с папками

Создать папку - Создайте новые папки в облачном хранилище.
Копировать папку - Дублирование папок в облачном хранилище.
Переместить папку - Перемещайте папки между каталогами в облачном хранилище.
Удалить папку - Удалите целые папки из облачного хранилища.

Лицензирование и аутентификация

Режим оценки - Попробуйте API с помощью бесплатной пробной учетной записи.
Безопасная аутентификация - Используйте идентификатор клиента и секрет клиента для безопасного доступа к API.
Лицензия MIT - Python SDK лицензируется по MIT License.

Поддерживаемые форматы документов

GroupDocs.Signature Cloud поддерживает подпись в следующих категориях форматов:

• Обработка текста: DOC, DOCX, DOCM, DOT, DOTX, DOTM, ODT, OTT, RTF, TXT
• Таблицы: XLS, XLSX, XLSB, XLSM, CSV, ODS, OTS, TSV
• Презентации: PPT, PPTX, PPTM, PPS, PPSX, PPSM, ODP, OTP, POTX, POTM
• PDF: PDF
• Изображения: BMP, GIF, JPEG, PNG, TIFF, SVG, PSD, WEBP, ICO, EMF, WMF, and more

Поддерживаемые типы подписей зависят от формата. Полную матрицу форматов см. в документации.

Быстрый старт

Получите учетные данные API

Чтобы использовать GroupDocs.Signature Cloud, зарегистрируйтесь на GroupDocs.Cloud Dashboard и получите свой Идентификатор клиента и Секрет клиента.

Инициализируйте API

Используйте следующий код, чтобы начать использовать Cloud SDK GroupDocs.Signature для 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)))

Благодаря этому краткому руководству вы можете начать подписывать документы с помощью GroupDocs.Signature Cloud в своих приложениях Python. Для получения более подробной информации посетите документацию.

Получить поддерживаемые форматы файлов

Получите полный список поддерживаемых форматов файлов, доступных через Signature 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 Samples включает готовые примеры, охватывающие:

Как запустить примеры

1. Клонируйте или загрузите репозиторий образцов.
2. Отредактируйте RunExamples.py и установите client_id и client_secret.
3. Перейдите в каталог «Примеры».
4. Запустите pip install groupdocs-signature-cloud -U
5. Выполните python RunExamples.py

Для получения более подробной информации посетите Начало работы.

Теги

eSignature API | Python Cloud API | GroupDocs.Signature Cloud | REST API | Цифровая подпись | Текстовая подпись | Подпись со штрих-кодом | Подпись QR-кода | Подписание документа | Проверка подписи | Поиск подписи | Интеграция облачного хранилища | Операции с файлами | Операции с папками | Безопасный доступ к API | Подписание PDF | Подписание документов Word | Подпись изображения | Штамп-подпись | Кроссплатформенный API | Безопасность документа | Электронная подпись