Zoho Sign PHP SDK

https://github.com/zoho/zsign-php-sdk
Admin
PHP SDK providing wrapper functions for Zoho Sign v1 API's Document Management and Template...
Tokens:5,265
Snippets:50
Trust Score:9.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Composer

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Command to install Composer, a dependency manager for PHP. Ensure Composer is installed before proceeding with SDK installation.

```bash
curl -sS https://getcomposer.org/installer | php
```

--------------------------------

### Install PHP SDK

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Command to install the Zoho Sign PHP SDK using Composer. This command should be run from the workspace of your client application.

```bash
composer require zoho-sign/php-sdk
```

--------------------------------

### Initialize SDK with OAuth2 Credentials

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Initialize the SDK by setting the OAuth2 credentials for the current user. This involves creating an OAuth object with client ID, secret, domain, and refresh token.

```php
$user = new OAuth( array(
    OAuth::CLIENT_ID => "",
    OAuth::CLIENT_SECRET => "",
    OAuth::DC => "COM", // allowed values : com/COM, in/IN, au/AU, eu/EU
    OAuth::REFRESH_TOKEN => "",
    OAuth::ACCESS_TOKEN => "" // optional. If not set, will auto refresh for access token
    ) );
ZohoSign::setCurrentUser( $user );
```

--------------------------------

### createTemplate

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Creates a Zoho Sign template. Requires a TemplateObject and an array of files. Returns the created TemplateObject.

```APIDOC
## createTemplate

### Description
Creates a Zoho Sign template.

### Method
createTemplate()

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **templateObject** (TemplateObject) - Required - The object containing template details.
- **files** (array) - Required - An array of files to be associated with the template.

### Request Example
```php
ZohoSign::createTemplate( $templateObject, $files );
```

### Response
#### Success Response
- **TemplateObject** - The created template object.

#### Response Example
```json
{
  "templateObject": { ... }
}
```

### Exceptions
- SignException
```

--------------------------------

### Include Autoloader

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Include the 'autoload.php' file generated by Composer to import SDK classes. This is a prerequisite for initializing the SDK.

```php
require 'vendor/autoload.php'
```

--------------------------------

### createNewFolder()

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Creates a new folder by the specified name if it does not already exist. It takes a request ID as input and returns the ID of the created folder. It may throw a SignException.

```APIDOC
## createNewFolder()

### Description
Creates a new folder by the name, if it doesnt exist already.

### Parameters
#### Path Parameters
- **request_id** (INT) - Required - The ID for the request.

### Return
- **folder_id** - The ID of the newly created folder.

### Throws
- **SignException** - If an error occurs during folder creation.
```

--------------------------------

### Use template to create a request and send for signature

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

This snippet shows how to use an existing template to create a new request. It populates predefined fields, assigns recipients, and then sends the template for signature.

```php
$template = ZohoSign::getTemplate( 2000002608137 );

    $template->setPrefillBooleanField	( "Premium Partner", true );
    $template->setPrefillTextField ( "Company", "Incredibles Inc" );
    $template->setPrefillDateField ( "Date", "08 July 2020" );

    $template->getActionByRole("Partner")->setRecipientName("John");
    $template->getActionByRole("Partner")->setRecipientEmail("john@incredibles.com");

    $resp_obj = ZohoSign::sendTemplate( $template, false );

```

--------------------------------

### getTemplatesList

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Fetches a list of templates, optionally sorted and paginated.

```APIDOC
## getTemplatesList

### Description
The function fetches the templates list of the specified range, sorted by 'sort_column' name. If no params are passed, it fetches the 100 results sorted by last modified time of the category type.

### Method
getTemplatesList()

### Parameters
#### Path Parameters
None

#### Query Parameters
- **start_index** (INT) - Optional, default:0 - The starting index for fetching templates.
- **row_count** (INT) - Optional, default:100, max:100 - The number of templates to fetch.
- **sort_order** (KEY NAME) - Optional, default:DESC - The sort order (ASC, DESC).
- **sort_column** (KEY NAME) - Optional, default:action_time - The column to sort by (action_time, request_name, folder_name, owner_first_name, recipient_email, created_time, modified_time).

### Request Example
```php
$templates = ZohoSign::getTemplatesList( 0, 50, 'ASC', 'created_time' );
```

### Response
#### Success Response
- **array** - An array of TemplateObject instances.

#### Response Example
```json
{
  "templates": [ { ... }, { ... } ]
}
```

### Exceptions
- SignException
```

--------------------------------

### getFolderList()

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Retrieves a list of all available folders. This function takes no parameters and returns a JSON-formatted array of stdClass objects.

```APIDOC
## getFolderList()

### Description
Retrieves list of folders.

### Parameters
- None

### Return
- **[JSON] array of stdClass** - A JSON array containing folder information.
```

--------------------------------

### setDownloadPath

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Sets the local directory path for downloading files.

```APIDOC
## setDownloadPath

### Description
Set the local directory path in which the files will be downloaded using ZohoSign functions. If not set, will default to "$\_SERVER['DOCUMENT_ROOT']" path returned by PHP.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **path** (String) - Required - The local directory path for downloads.

### Return
-

### Throws
-
```

--------------------------------

### getDownloadPath

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Returns the currently set local download directory path.

```APIDOC
## getDownloadPath

### Description
Return the local download directory path set. If not set, will default to "$\_SERVER['DOCUMENT_ROOT']" path returned by PHP.

### Method
Not specified (assumed SDK method call)

### Parameters
- None

### Return
-

### Throws
-
```

--------------------------------

### downloadCompletionCertificate

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Downloads the completion certificate for a signing completed request.

```APIDOC
## downloadCompletionCertificate

### Description
Downloads the completion certificate ONLY for the signing completed request. Completion Certificate PDF will be downloaded to the directory path returned by 'getDownloadPath()' function.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **requrest_id** (INT) - Required - The ID of the completed request.

### Return
true

### Throws
SignException
```

--------------------------------

### Create a Zoho Sign request using a document with text-tags and a signer

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

This snippet demonstrates how to create a Zoho Sign request from a document containing text-tags and a signer. It then sends the draft for signature.

```php
$reqObj = new RequestObject();
    $reqObj->setRequestName		( 'Partnership Agreement' );

    $partner = new Actions();
    $partner->setRecipientName		( "Will Smith" );
    $partner->setRecipientEmail		( "Willsmith@zylker.com" );
    $partner->setActionType		( Actions::SIGNER );
    $partner->setisEmbedded		( true );

    $reqObj->addAction		( $partner );

    $file1 = $_SERVER['DOCUMENT_ROOT']."/Documents/TextTagsAPI.pdf";
    $files = [
        new CURLfile( $file1 )
    ];

    $draftJSON	= ZohoSign::draftRequest( $reqObj,  $files);

```

--------------------------------

### sendTemplate

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Sends a template for signature or creates a draft. The templateObject should have prefill-fields filled.

```APIDOC
## sendTemplate

### Description
The templateObject input param contains the TemplateObject returned by the "getTemplate()" function with the prefill-fields filled. Setting the quick send params as true sends the document for signature. Setting false, only creates a draft.

### Method
sendTemplate()

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **templateObject** (TemplateObject) - Required - The TemplateObject with prefill-fields filled.
- **quick_send** (Boolean) - Required - True to send for signature, false to create a draft.

### Request Example
```php
$resp_obj = ZohoSign::sendTemplate( $template, false );
```

### Response
#### Success Response
- **RequestObject** - Contains the RequestObject of the created request (either a DRAFT or INPROGRESS request).

#### Response Example
```json
{
  "requestObject": { ... }
}
```

### Exceptions
- SignException
```

--------------------------------

### draftRequest

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Uploads files and drafts a request with the specified properties.

```APIDOC
## draftRequest

### Description
Uploads the files and draft's a request with the properties.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **requestObject** (RequestObject) - Required - The request object containing properties.
- **files** (array) - Required - An array of files to upload.

### Return
instance of RequestObject

### Throws
SignException
```

--------------------------------

### downloadRequest

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Downloads the documents of a request to the configured download path.

```APIDOC
## downloadRequest

### Description
Downloads the documents of the request with its current version of signatures placed, either as a PDF if single document or as ZIP of multiple documents. Documents will be downloaded to the directory path returned by 'getDownloadPath()' function.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **requrest_id** (INT) - Required - The ID of the request to download.

### Return
true

### Throws
SignException
```

--------------------------------

### addFilesToTemplate

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Adds files to an existing template using its ID.

```APIDOC
## addFilesToTemplate

### Description
Adds files to the template.

### Method
addFilesToTemplate()

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **template_id** (INT) - Required - The ID of the template to which files will be added.
- **files** (array) - Required - An array of files to add.

### Request Example
```php
ZohoSign::addFilesToTemplate( $templateId, $filesToAdd );
```

### Response
#### Success Response
- **TemplateObject** - The updated template object.

#### Response Example
```json
{
  "templateObject": { ... }
}
```

### Exceptions
- SignException
```

--------------------------------

### getRequestList

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Fetches a list of documents by category name with optional sorting and pagination.

```APIDOC
## getRequestList

### Description
The function fetches the document list by category name. If only category name is specified, it fetches the 100 results sorted by last modified time of the category type.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **category** (KEY NAME) - Required - Category name (values: ALL, DRAFT, INPROGRESS, RECALLED, COMPLETED, DECLINED, EXPIRED, EXPIRING, MY_REQUESTS, MY_PENDING, SHREDDED).
- **start_index** (INT) - Optional - Default: 0. The starting index for fetching requests.
- **row_count** (INT) - Optional - Default: 100, Max: 100. The number of requests to fetch.
- **sort_order** (KEY NAME) - Optional - Default: DESC. Sort order (values: ASC, DESC).
- **sort_column** (KEY NAME) - Optional - Default: action_time. Column to sort by (values: action_time, request_name, folder_name, owner_first_name, recipient_email, created_time, modified_time).

### Return
array of instances of RequestObject

### Throws
SignException
```

--------------------------------

### createRequestType()

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Creates a new request type with a specified name and description. It returns an instance of 'RequestType'.

```APIDOC
## createRequestType(name, description)

### Description
Creates a new request type.

### Parameters
#### Path Parameters
- **name** (String) - Required - The name for the new request type.
- **description** (String) - Required - The description for the new request type.

### Return
- An instance of 'RequestType'.
```

--------------------------------

### downloadDocument

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Downloads a specific document of a request as a PDF to the configured download path.

```APIDOC
## downloadDocument

### Description
Downloads the specific document of the request with its current version of signatures placed as a PDF. Documents will be downloaded to the directory path returned by 'getDownloadPath()' function.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **request_id** (INT) - Required - The ID of the request.
- **document_id** (INT) - Required - The ID of the document to download.

### Return
true

### Throws
SignException
```

--------------------------------

### generateEmbeddedSigningLink

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Generates and returns a signing link for a specified signer, valid for 3 minutes.

```APIDOC
## generateEmbeddedSigningLink

### Description
Generates and return a signing link for the signer specified by action_id. Add the 'host' param for the website in which you want to embedd. NOTE: The signing URL is valid ONLY for 3 minutes before which the link has to be opened/loaded.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **request_id** (INT) - Required - The ID of the request.
- **action_id** (INT) - Required - The ID of the action for the signer.
- **host** (URL) - Optional - Default: 'null'/for opening in new tab. The host URL for embedding.

### Return
URL string

### Throws
SignException
```

--------------------------------

### addFilesToRequest

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Uploads files to an existing draft request.

```APIDOC
## addFilesToRequest

### Description
Uploads the files to a draft request.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **request_id** (INT) - Required - The ID of the draft request.
- **files** (array) - Required - An array of files to upload.

### Return
instance of RequestObject

### Throws
SignException
```

--------------------------------

### getRequest

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Fetches the details of a Zoho Sign Request by its request ID.

```APIDOC
## getRequest

### Description
Fetch the details of a Zoho Sign Request by its request id.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **request_id** (INT) - Required - The ID of the request to fetch.

### Return
instance of RequestObject

### Throws
SignException
```

--------------------------------

### submitForSignature

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Submits a draft request for signature.

```APIDOC
## submitForSignature

### Description
The requestObject contains a reference for a 'draft' request with fields added. The function submits the 'draft' for signature.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **requestObject** (RequestObject) - Required - The request object containing a reference to a draft request.

### Return
instance of RequestObject

### Throws
SignException
```

--------------------------------

### getTemplate

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Retrieves a template object by its ID, including its properties and prefill-fields.

```APIDOC
## getTemplate

### Description
Return the template object with its properties, which can be used to fill the prefill-fields and can be used for submission.

### Method
getTemplate()

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **template_id** (INT) - Required - The ID of the template to retrieve.

### Request Example
```php
$template = ZohoSign::getTemplate( $templateId );
```

### Response
#### Success Response
- **TemplateObject** - The retrieved template object.

#### Response Example
```json
{
  "templateObject": { ... }
}
```

### Exceptions
- SignException
```

--------------------------------

### updateTemplate

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Updates an existing template with new properties and optionally adds files. The TemplateObject must have the request_id set.

```APIDOC
## updateTemplate

### Description
Updates an existing template with new properties and optionally adds files. The TemplateObject must have the request_id set.

### Method
updateTemplate( $templateObject, $files=null )

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **templateObject** (TemplateObject) - Required - The object containing updated template details. Must include request_id.
- **files** (array) - Optional - An array of files to add to the template.

### Request Example
```php
ZohoSign::updateTemplate( $updatedTemplateObject, $newFiles );
```

### Response
#### Success Response
- **TemplateObject** - The updated template object.

#### Response Example
```json
{
  "templateObject": { ... }
}
```

### Exceptions
- SignException
```

--------------------------------

### Refresh Access Token

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Generate a new access token using a refresh token. This is typically done when the current access token has expired.

```php
$user->generateAccessTokenUsingRefreshToken();
```

--------------------------------

### selfSignRequest

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Signs a draft request as the current user.

```APIDOC
## selfSignRequest

### Description
The requestObject contains a reference for a 'draft' request with fields added. The function signs the document as the current user. Throws 'SignException' if failed to sign, usually due to wrong field properties set.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **requestObject** (RequestObject) - Required - The request object containing a reference to a draft request.

### Return
instance of RequestObject

### Throws
SignException
```

--------------------------------

### updateRequest

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Uploads files and updates a draft request with the specified properties.

```APIDOC
## updateRequest

### Description
Uploads the files and draft's a request with the properties.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **requestObject** (RequestObject) - Required - The request object containing properties.
- **files** (array) - Required - An array of files to upload.

### Return
instance of RequestObject

### Throws
SignException
```

--------------------------------

### getRequestTypes()

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Retrieves a list of all request types. This function takes no parameters and returns an array of 'RequestType' instances.

```APIDOC
## getRequestTypes()

### Description
Retrieves all request types.

### Parameters
- None

### Return
- An array of instances of 'RequestType'.
```

--------------------------------

### remindRequest

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Sends a reminder to the recipient of a request.

```APIDOC
## remindRequest

### Description
Sends a reminder to the recipient of the request.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **request_id** (INT) - Required - The ID of the request to send a reminder for.

### Return
true

### Throws
SignException
```

--------------------------------

### getFieldTypes()

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Retrieves all available field types within the Zoho ZSign system. This function takes no parameters and returns a stdClass object containing the field types.

```APIDOC
## getFieldTypes()

### Description
Retrieves all field types.

### Parameters
- None

### Return
- **field_types** (stdClass) - An object containing all available field types.
```

--------------------------------

### recallRequest

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Recalls a submitted request.

```APIDOC
## recallRequest

### Description
Recalls the request if submitted.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **request_id** (INT) - Required - The ID of the request to recall.

### Return
true

### Throws
SignException
```

--------------------------------

### deleteRequest

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Deletes a request. Deleted requests are moved to 'Trash'.

```APIDOC
## deleteRequest

### Description
Deletes the request. Deleted requests will be available in 'Trash'.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **request_id** (INT) - Required - The ID of the request to delete.

### Return
true

### Throws
SignException
```

--------------------------------

### deleteTemplate

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Permanently deletes a template by its ID.

```APIDOC
## deleteTemplate

### Description
Permanently deletes the template.

### Method
deleteTemplate()

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **template_id** (INT) - Required - The ID of the template to delete.

### Request Example
```php
$success = ZohoSign::deleteTemplate( $templateId );
```

### Response
#### Success Response
- **true** - Indicates successful deletion.

#### Response Example
```json
{
  "status": true
}
```

### Exceptions
- SignException
```

--------------------------------

### getFieldDataFromCompletedDocument

Source: https://github.com/zoho/zsign-php-sdk/blob/main/README.md

Retrieves the PDF form data (key:value pairs) from a completed document.

```APIDOC
## getFieldDataFromCompletedDocument

### Description
Returns the pdf fields form data with key:value as data_label:data_value.

### Method
Not specified (assumed SDK method call)

### Parameters
#### Path Parameters
- **requestId** (INT) - Required - The ID of the completed request.

### Return
instance of DocumentFormData

### Throws
SignException
```
Tokens:
Raw