Zoho CRM PHP SDK

https://github.com/zoho/zcrm-php-sdk
Admin
PHP SDK for Zoho CRM APIs that provides wrapper methods for invoking Zoho CRM APIs from client...
Tokens:2,935
Snippets:37
Trust Score:9.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Composer

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

Run this command to install Composer, a dependency manager for PHP. Ensure you have PHP 5.6 or above with the curl extension enabled.

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

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

### Install PHP SDK

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

Navigate to your client app's workspace and run this command to install the Zoho CRM PHP SDK using Composer.

```bash
composer require zohocrm/php-sdk
```

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

### Initialize SDK Configuration

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

This code snippet initializes the Zoho CRM SDK with your application's configuration details. It's required every time your client app starts.

```php
$configuration =array("client_id"=>"{client_id}","client_secret"=>"{client_secret}","redirect_uri"=>"{redirect_url}","currentUserEmail"=>"{user_email_id}");
ZCRMRestClient::initialize($configuration);
```

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

### Get Instance of a Module

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

Obtain a dummy instance of a module to access its non-static functions without triggering an API call.

```php
$zcrmModuleIns = ZCRMModule::getInstance("Invoices");
```

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

### Initialize with Sandbox

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

To use the sandbox environment, set the 'sandbox' key to true in the configuration array.

```php
$configuration = [
    "client_id" => "YOUR_CLIENT_ID",
    "client_secret" => "YOUR_CLIENT_SECRET",
    "redirect_uri" => "YOUR_REDIRECT_URI",
    "currentUserEmail" => "user@example.com",
    "sandbox" => true
];

ZCRMRestClient::initialize($configuration);
```

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

### Initialize with Custom Log Path

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

Specify a custom path for the application log file using the 'applicationLogFilePath' key in the configuration array.

```php
$configuration = [
    "client_id" => "YOUR_CLIENT_ID",
    "client_secret" => "YOUR_CLIENT_SECRET",
    "redirect_uri" => "YOUR_REDIRECT_URI",
    "currentUserEmail" => "user@example.com",
    "applicationLogFilePath" => "/path/to/your/logs"
];

ZCRMRestClient::initialize($configuration);
```

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

### Initialize with Custom Accounts URL

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

Set a custom accounts URL using the 'accounts_url' key. This is mandatory for non-COM domains.

```php
$configuration = [
    "client_id" => "YOUR_CLIENT_ID",
    "client_secret" => "YOUR_CLIENT_SECRET",
    "redirect_uri" => "YOUR_REDIRECT_URI",
    "currentUserEmail" => "user@example.com",
    "accounts_url" => "accounts.zoho.eu"
];

ZCRMRestClient::initialize($configuration);
```

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

### Initialize ZCRM Client

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

Call ZCRMRestClient::initialize() with a configuration array on application startup. The configuration array must contain authentication credentials.

```php
$configuration = [
    "client_id" => "YOUR_CLIENT_ID",
    "client_secret" => "YOUR_CLIENT_SECRET",
    "redirect_uri" => "YOUR_REDIRECT_URI",
    "currentUserEmail" => "user@example.com"
];

ZCRMRestClient::initialize($configuration);
```

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

### Initialize with Custom API Base URL

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

Set a custom API base URL using the 'apiBaseUrl' key. This is mandatory for non-COM domains.

```php
$configuration = [
    "client_id" => "YOUR_CLIENT_ID",
    "client_secret" => "YOUR_CLIENT_SECRET",
    "redirect_uri" => "YOUR_REDIRECT_URI",
    "currentUserEmail" => "user@example.com",
    "apiBaseUrl" => "www.zohoapis.eu"
];

ZCRMRestClient::initialize($configuration);
```

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

### Create Sample Invoice Record

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

Instantiates and populates a ZCRMRecord for an Invoice, including setting subject, account name, and adding line items with taxes, quantity, and discount.

```php
$record=ZCRMRecord::getInstance("Invoices",null);
$record->setFieldValue("Subject","Iphone sale to John");
$record->setFieldValue("Account_Name","410405000001016021");
$productInstance=ZCRMRecord::getInstance("Products",410405000001108011);
$lineItem=ZCRMInventoryLineItem::getInstance($productInstance);
$taxInstance1=ZCRMTax::getInstance("Sales Tax");
$taxInstance1->setPercentage(2);
$taxInstance1->setValue(10);
$lineItem->addLineTax($taxInstance1);
$taxInstance1=ZCRMTax::getInstance("Vat");
$taxInstance1->setPercentage(12);
$taxInstance1->setValue(60);
$lineItem->addLineTax($taxInstance1);
$lineItem->setQuantity(100);
$lineItem->setDiscount(0.5);
$record->addLineItem($lineItem);
```

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

### Initialize with Persistence Handler

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

Implement ZohoOAuthPersistenceInterface and specify the class name using 'persistence_handler_class' for custom token persistence.

```php
$configuration = [
    "client_id" => "YOUR_CLIENT_ID",
    "client_secret" => "YOUR_CLIENT_SECRET",
    "redirect_uri" => "YOUR_REDIRECT_URI",
    "currentUserEmail" => "user@example.com",
    "persistence_handler_class" => "com.example.MyPersistenceHandler"
];

ZCRMRestClient::initialize($configuration);
```

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

### Create Records in a Module

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

Create multiple records within a module using an array of ZCRMRecord instances. Handles success and failure statuses for each record.

```php
$bulkAPIResponse=$zcrmModuleIns->createRecords($recordsArray); // $recordsArray - array of ZCRMRecord instances filled with required data for creation.
$entityResponses = $bulkAPIResponse->getEntityResponses();
foreach($entityResponses as $entityResponse)
{
	if("success"==$entityResponse->getStatus())
	{
		echo "Status:".$entityResponse->getStatus();
		echo "Message:".$entityResponse->getMessage();
		echo "Code:".$entityResponse->getCode();
		$createdRecordInstance=$entityResponse->getData();
		echo "EntityID:".$createdRecordInstance->getEntityId();
	}
}
```

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

### Include SDK Autoloader

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

Include this line in your PHP files to access all functionalities provided by the Zoho CRM PHP SDK.

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

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

### Fetch Records from a Module

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

Retrieves all records from a specified module (e.g., Contacts) using the Zoho CRM PHP SDK. The response data is an array of ZCRMRecord instances.

```php
$zcrmModuleIns = ZCRMModule::getInstance("Contacts");
$bulkAPIResponse=$zcrmModuleIns->getRecords();
$recordsArray = $bulkAPIResponse->getData();
```

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

### Generate Access Token from Grant Token

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

Use this snippet to generate an access token using a self-authorized grant token. This is typically a one-time process after obtaining the grant token.

```php
$configuration =array("client_id"=>"{client_id}","client_secret"=>"{client_secret}","redirect_uri"=>"{redirect_url}","currentUserEmail"=>"{user_email_id}");
ZCRMRestClient::initialize($configuration);
$oAuthClient = ZohoOAuth::getClientInstance();
$grantToken = "paste_the_self_authorized_grant_token_here";
$oAuthTokens = $oAuthClient->generateAccessToken($grantToken);
```

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

### Set Current User

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

For single-user authentication, set the current user's email using ZCRMRestClient->setCurrentUser().

```php
$configuration = [
    "client_id" => "YOUR_CLIENT_ID",
    "client_secret" => "YOUR_CLIENT_SECRET",
    "redirect_uri" => "YOUR_REDIRECT_URI",
    "currentUserEmail" => "user@example.com"
];

ZCRMRestClient::initialize($configuration);

// For single user authentication
ZCRMRestClient->setCurrentUser("user@example.com");
```

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

### Generate Access Token from Refresh Token

Source: https://github.com/zoho/zcrm-php-sdk/blob/master/README.md

This snippet generates an access token using a refresh token. It also requires a user identifier, such as an email address. This is a one-time process.

```php
$configuration =array("client_id"=>"{client_id}","client_secret"=>"{client_secret}","redirect_uri"=>"{redirect_url}","currentUserEmail"=>"{user_email_id}");
ZCRMRestClient::initialize($configuration);
$oAuthClient = ZohoOAuth::getClientInstance();
$refreshToken = "paste_the_refresh_token_here";
$userIdentifier = "provide_user_identifier_like_email_here";
$oAuthTokens = $oAuthClient->generateAccessTokenFromRefreshToken($refreshToken,$userIdentifier);
```
Tokens:
Raw