Introducing Python SDK for GroupDocs.Signature Cloud

GroupDocs.Signature CloudThe GroupDocs Cloud team is committed to provide SDKs for different platform for its users. In this regard, we are glad to inform you about another SDK release, GroupDocs.Signature Cloud SDK for Python. This SDK provides a complete solution to consume GroupDocs.Signature Cloud API in Python to sign supported documents in your cloud application.

GroupDocs.Signature Cloud is REST API which supports sign documents (over 20+ document formats) with different signature types like Text Signatures with various format, Image Signatures, Digital Signatures, Barcode and QR-Code Signatures. It also provides support to verify documents for signatures, search for signatures in documents and many more. Please click here for further details. GroupDocs.Signature Cloud SDK for Python has been developed to help you integrate all these features in your Python based application without any hassle.

GroupDocs.Signature Cloud SDK for Python – Introduction

GroupDocs.Signature Cloud SDK for Python is introduced for its Python developers. It is a wrapper around REST APIs, that allows you to work with GroupDocs.Signature Cloud REST APIs in Python based platform quickly and easily, gaining all benefits of strong types and IDE highlights. The distribution is available at GitHub.

GroupDocs.Signature Cloud SDK for Python – Examples

GroupDocs.Signature Cloud SDK for Python Examples are also available to guide developers to get familiar with SDK and its usage to invoke resources and operations using the GroupDocs.Signature Cloud REST API. Please see the SDK examples of following categories.

Installation

GroupDocs.Signature Cloud SDK for Python is also available as released package in the PyPI (Python Package Index). You can bypass source code repository and depend directly on the released package by installing from PyPI:

pip install groupdocs-signature-cloud

Data

In order to render any supported files, you first need to upload them to the GroupDocs cloud storage or 3rd party cloud storage to use GroupDocs.Signature Cloud API.

Getting Started

Once you are done with installation of package and dependencies in your project, You can easily call the API in your Python based code to consume the API features. Here is the sample code to demonstrate the working of GroupDocs.Signature Cloud API using Python SDK. Please follow the installation procedure and then run the following Python code:

# Import module
 import asposestoragecloud
 import groupdocs_signature_cloud
 from groupdocs_signature_cloud.models.requests.post_search_barcode_request import PostSearchBarcodeRequest
 from groupdocs_signature_cloud.models import *

 host = "http://api-qa.groupdocs.cloud"   # Put your Host URL here
 base_url = "http://api-qa.groupdocs.cloud/v1" #Put your Base URL here
 api_key = "" #Put your App Key here
 app_sid = "" #Put your App Sid here
 storageName = "Signature-Dev" #Put your storage name here
 storageFolder = "signed" #Put your storage folder path here
 storageFileName = "SignedForVerificationAll.pdf" #Put your storage file name here
 filePassword = "" #Put your file password here if file is encrypted
 localFilePath = "C:\\SignedForVerificationAll.pdf" #Put your local file path here

 # File uploading (it could be skipped if file is already uploaded)
 # initialization of configuration for storage api client
 storageConfiguration = asposestoragecloud.Configuration()
 storageConfiguration.host = host
 storageConfiguration.base_url = base_url
 storageConfiguration.api_key_prefix = "Bearer"

 # initialization of storage api client
 storageApiClient = asposestoragecloud.ApiClient(apiKey = api_key, appSid = app_sid, configuration = storageConfiguration)
 storageApi = asposestoragecloud.apis.StorageApi(storageApiClient)
 # file uploading
 filestream = open(file = localFilePath, mode = "rb")
 storageApi.put_create(path = storageFolder + "\\" + storageFileName, file = filestream, storage = storageName)      
 filestream.close()    
 print("Uploaded: " + storageFolder + "\\" + storageFileName)     

 # Signature search
 # initialization of configuration for signature api client
 configuration = groupdocs_signature_cloud.Configuration()
 configuration.host = host
 configuration.base_url = base_url
 configuration.api_key["api_key"] = api_key
 configuration.api_key["app_sid"] = app_sid
 
 # initialization of signature api client
 signatureApi = groupdocs_signature_cloud.SignatureApi(configuration=configuration)

 # initialization of search options
 options = PdfSearchBarcodeOptionsData()
 # set barcode properties
 options.barcode_type_name ="Code39Standard"
 options.text = "12345678"
 # set match type
 options.match_type ="Contains"
 #set pages for search
 options.document_page_number = 1

 # initialization of search request
 request = PostSearchBarcodeRequest(storageFileName, options, filePassword, storageFolder, storageName)

 # getting response
 response = signatureApi.post_search_barcode(request)
 
 # checking response
 self.assertNotEqual(response, False)
 self.assertEqual(response.code, "200")
 self.assertEqual(response.status, "OK")
 self.assertIn(storageFileName, response.file_name)
 self.assertEqual(response.folder, storageFolder)
 self.assertNotEqual(response.signatures, False)
 self.assertGreater(len(response.signatures), 0)
 signature = response.signatures[0]
 self.assertEqual(signature.text, "123456789012")
 self.assertEqual(signature.barcode_type_name, "Code39Standard")
 self.assertIn("BarcodeSignatureData", signature.signature_type)   

GroupDocs.Signature Cloud Resources

Following are the links to some useful resources you may need to accomplish your tasks.

Start a Free Trial Today

Start a free trial today – all you need is to sign up with the GroupDocs Cloud service. Once you have signed up, you are ready to try the powerful file processing features offered by GroupDocs Cloud.

Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedIn