Kaizen #94 - PHP SDK V4 - Configuration and Initialization

Hello and welcome to another Kaizen week!

In previous Kaizen posts, we have covered in detail how to configure and initialize PHP SDKs for Zoho CRM v2.1 APIs. We have since released SDKs for v4 and v5 APIs. However, starting from v4, there are some changes in the configuration and initialization process.  In this post, we will discuss you how to configure and initialize PHP SDK v4 and v5.

The PHP Software Development Kit (SDK) simplifies the integration of client PHP applications with Zoho CRM. Acting as a wrapper for the REST APIs, it streamlines the usage of Zoho CRM services. 

Before proceeding with the configuration, make that your client application meets the prerequisites. This includes having PHP 7 or above installed, along with the cURL extension, which is necessary for connecting and communicating with Zoho CRM APIs.

I. Register your application with Zoho CRM

Registering your application with Zoho CRM is a mandatory step in order to authenticate and authorize API calls using the OAuth2.0 standards.

1. Go to https://api-console.zoho.com
   
2. Click on Get Started or +ADD CLIENT.
   
3. Choose the Client Type as Self-Client or Server based Applications depending on your application.
4. Fill in the necessary details and click CREATE. Once you successfully register your self-client, you will receive a Client ID and Client Secret.
   

II. Installing the PHP SDK 

1. If not already installed, follow the instructions provided at the corresponding link to install Composer.
   
   

   Mac/Linux	curl -sS https://getcomposer.org/installer | php (terminal command)  https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx
   Windows	https://getcomposer.org/doc/00-intro.md#installation-windows

   
   
2. Install PHP-SDK using Composer
   
1. Navigate to the workspace of your client app.
   
2. Run the following command in the workspace. Upon successful installation, the system will create a package named vendor in the workspace of your client app. 

   composer require zohocrm/php-sdk-4.0 (for v4 APIs)  composer require zohocrm/php-sdk-5.0 (for v5 APIs)

3. To use the SDK in your project, add the following line in your project PHP files. This loads and includes our PHP-SDK library in your project. If you skip this step, you will get a fatal error in response due to the missing libraries.
   

   require 'vendor/autoload.php';

   
   

III. Token Persistence

Token persistence refers to storing and utilizing authentication tokens provided by Zoho, enabling the SDK to refresh the access tokens without user intervention. The SDK offers three types of persistence - File, DB, and Custom - with file persistence being the default method. 

The persistence is achieved by writing an implementation of the inbuilt TokenStore interface, which has the following callback methods. 

Methods	Description
findToken(Token $token)	Invoked before firing a request to fetch the saved tokens. This method returns an implementation of Token interface object for the library to process it.
saveToken(Token $token)	Invoked after fetching access and refresh tokens from Zoho. This method saves the token details.
deleteToken($id)	This method is used to delete the given token details.
getTokens()	The method is used to retrieve all the stored tokens.
deleteTokens()	The method to delete all the stored tokens.
findTokenById($id)	This method is used to retrieve the user token details based on the unique ID.

Here, $token is an instance of the Token interface.

Token Persistence using a Database

In Database persistence, tokens are stored and retrieved from a database (e.g., MySQL).

Create a table in your database with the following required columns. For example, if you want to persist your tokens in a table named token in database named zoho, use this:

CREATE DATABASE zoho; // use this to create database named zoho // use this to create a table named token, with the following necessary columns CREATE TABLE token (    id varchar(10) NOT NULL,   user_name varchar(255) NOT NULL,   client_id varchar(255),   client_secret varchar(255),   refresh_token varchar(255),   access_token varchar(255),   grant_token varchar(255),   expiry_time varchar(20),   redirect_url varchar(255),   primary key (id) );

Note that the columns are different for API v2.1. Please refer to this post for more details. . 

File Persistence

File Persistence allows storing and retrieving the authentication tokens from the given file path. The file contains id, user_name, client_id, client_secret, refresh_token, access_token, grant_token, expiry_time and redirect_url. 

Custom Persistence

Custom Persistence refers to a technique where users can create their own method of storing and retrieving authentication tokens. To use this method, users need to implement the TokenStore interface and override its methods according to their own logic.

IV. Configuration

The configuration step involves setting up various details in the SDK, such as user authentication, token persistence, logging, API call timeout settings, and more. The following keys are defined during this process:

1. environment (mandatory): The API environment which decides the domain and the URL to make API calls, in Domain::Environment pattern.
   Domains : USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
   Environments : PRODUCTION(), DEVELOPER(), SANDBOX()
2. Token (mandatory): This key contains the user token details. Create an instance of OAuthToken with the information that you get after registering your Zoho client.  Depending on the available tokens, you can select one of the following flows:
   
   Note : You need to generate the tokens (grant/access/refresh) beforehand to use them in the respective flows.
   
   a) grantToken flow - You should use the grant Token for configuration.
   

   $token = (new OAuthBuilder())   ->clientId("clientId")   ->clientSecret("clientSecret")   ->userSignature($user) //optional   ->grantToken("grantToken")   ->redirectURL("redirectURL") //optional   ->build();

   
   
   b) refreshToken flow - Utilize the refresh token in this flow.
   

   $token = (new OAuthBuilder())   ->clientId("clientId")   ->clientSecret("clientSecret") ->userSignature($user) //optional   ->refreshToken("refreshToken")   ->build();

   
   
   c) accessToken flow - You can use the access token to configure in this flow. Please note that the token will not be persisted in this case, and the access token will be directly used to make the API calls.
   

   $token = (new OAuthBuilder())    ->userSignature($user) //optional    ->accessToken("accessToken")    ->build();

   
   
   d) id flow - You can use the id from the persisted token file/DB to make API calls. The id is a unique system generated value for each token details entry in the file/DB.
   

   $token = (new OAuthBuilder())    ->id("id")    ->build();

   
   
3. logger (optional) : Create an instance of Logger Class to log exception and API information. You can set the level you want to log (FATAL, ERROR, WARNING, INFO, DEBUG, TRACE, ALL, OFF), and also configure the file path and file name for the log file. The default level is OFF.
   
   
   

   $logger = (new LogBuilder())   ->level(Levels::INFO)   ->filePath("/Documents/php_sdk_log.log")   ->build();

   
   
4. store (optional) : Configure your token persistence using this method. If this is skipped, the SDK creates the sdk_tokens.txt in the current working directory to persist the tokens by default. For more details, refer here.
5. SDKConfig (optional) : The additional SDK configurations are taken care of with this method. 
   

   Configuration Key	Description
   autoRefreshFields  Default Value : False	A boolean configuration key to enable or disable automatic refreshing of module fields in the background. If set to true, fields are refreshed every hour, and if set to false, fields must be manually refreshed or deleted.
   pickListValidation  Default Value : True	This field enables or disables pick list validation. If enabled, user input for pick list fields is validated, and if the value does not exist in the pick list, the SDK throws an error. If disabled, the input is not validated and the API call is made.
   enableSSLVerification  Default Value : True	A boolean field to enable or disable curl certificate verification. If set to true, the SDK verifies the authenticity of certificate. If set to false, the SDK skips the verification.
   connectionTimeout  Default Value : 0	The maximum time (in seconds) to wait while trying to connect. Use 0 to wait indefinitely.
   timeout  Default Value : 0	The maximum time (in seconds) to allow cURL functions to execute. Use 0 to wait indefinitely.

   
   
6. requestProxy (optional) : Contains the proxy properties of the user. Configure this only if you're using a proxy server to make the API calls.
   

   $requestProxy = (new ProxyBuilder())  ->host("proxyHost")  ->port("proxyPort")  ->user("proxyUser")  ->password("password")  ->build();

   
   
7. resourcePath (optional) : Configure the absolute directory path to store user specific files containing module fields information. If skipped, the files will be stored in the project directory itself.

V. Initilization

After completing the configuration, you can proceed with initializing the SDK, and begin making API requests.

Here is a sample code to initialize the SDK, using refresh token flow and DB Persistence. 

<?php   use com\zoho\api\authenticator\OAuthBuilder;   use com\zoho\api\authenticator\store\DBBuilder;   use com\zoho\crm\api\InitializeBuilder;   use com\zoho\crm\api\UserSignature;   use com\zoho\crm\api\dc\USDataCenter;   use com\zoho\api\logger\LogBuilder;   use com\zoho\api\logger\Levels;   use com\zoho\crm\api\SDKConfigBuilder;   use com\zoho\crm\api\ProxyBuilder;   require_once "vendor/autoload.php";   class Initialize   {     public static function initializeSDK()     {       $user = new UserSignature("patricia@zoho.com");       $environment = USDataCenter::PRODUCTION();       $token = (new OAuthBuilder())         ->clientId("1000.xxxxxxxxxxxxxxxx")         ->clientSecret("554a9xxxxxxxxxxxxxxxxx") ->userSignature($user) //optional         ->refreshToken("1000.xxxxxxxxxxxxxxxxxxxx")          ->redirectURL("www.zoho.com") //optional         ->build();      $logger = (new LogBuilder())        ->level(Levels::INFO)        ->filePath("/Documents/php_sdk_log.log")        ->build();      $tokenstore = (new DBBuilder())        ->host("insert_your_hostname_here")        ->databaseName("insert_your_database_name_here")        ->userName("insert_your_db_username_here")        ->password("insert_your_db_password_here")        ->portNumber("insert_your_portnumber_here")        ->tableName("insert_your_table_name_here")        ->build();      $autoRefreshFields = false;      $pickListValidation = false;      $connectionTimeout = 2;      $timeout = 2;      $enableSSLVerification = false;      $configInstance = (new SDKConfigBuilder())        ->autoRefreshFields($autoRefreshFields)        ->pickListValidation($pickListValidation)        ->sslVerification($enableSSLVerification)        ->connectionTimeout($connectionTimeout)        ->timeout($timeout)        ->build();      $resourcePath = "/Documents/phpsdk-application";      $requestProxy = (new ProxyBuilder())        ->host("proxyHost")        ->port("proxyPort")        ->user("proxyUser")        ->password("password")        ->build();     (new InitializeBuilder())       ->environment($environment)       ->token($token)       ->store($tokenstore) //optional       ->SDKConfig($configInstance) //optional       ->resourcePath($resourcePath) //optional       ->logger($logger) //optional       ->requestProxy($requestProxy) //optional       ->initialize();    }  } Initialize::initializeSDK(); ?>

You are now set to use the PHP SDK and make API calls. 

If you have any queries, let us know the comments below, or send an email to support@zohocrm.com. We would love to hear from you!

Cheers!

• Topic Participants

• Anu Abraham

  

• Sticky Posts

• Kaizen #197: Frequently Asked Questions on GraphQL APIs

  🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.

• Kaizen #198: Using Client Script for Custom Validation in Blueprint

  Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.

• Celebrating 200 posts of Kaizen! Share your ideas for the milestone post

  Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQs

• Kaizen #193: Creating different fields in Zoho CRM through API

  🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.

• Client Script | Update - Introducing Commands in Client Script!

  Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands

• Recent Topics

• Download an email template in html code

  Hello everyone, I have created an email template and I want to download it as html. How can i do that? I know you can do it via the campaigns-first create a campaign add the template and download it as html from there. But what if i don't want to create

• Attachment is not included in e-mails sent through Wordpress

  I have a Wordpress site with Zeptomail Wordpress plugin installed and configured. E-mails are sent ok through Zeptomail but without the included attachment (.pdf file) Zeptomail is used to send tickets to customers through Zeptomail. E-Mails are generated

• Upcoming Changes to the Timesheet Module

  The Timesheet module will undergo a significant change in the upcoming weeks. To start with, we will be renaming Timesheet module to Time Logs. This update will go live early next week. Significance of this change This change will facilitate our next

• Best way to schedule bill payments to vendors

  I've integrated Forte so that I can convert POs to bills and make payments to my vendors all through Books. Is there a way to schedule the bill payments as some of my vendors are net 30, net 60 and even net 90 days. If I can't get this to work, I'll have

• Cant update image field after uploading image to ZFS

  Hello i recently made an application in zoho creator for customer service where customers could upload their complaints every field has been mapped from creator into crm and works fine except for the image upload field i have tried every method to make

• Billing Management: #4 Negate Risk Free with Advances

  In the last post, we explored how unbilled charges accumulate before being invoiced. But what happens when businesses need money before service begins? Picture this: A construction company takes on a $500,000 commercial building project expected to last

• Is there an equivalent to the radius search in RECRUIT available in the CRM

  We have a need to find all Leads and/or Contacts within a given radius of a given location (most likely postcode) but also possibly an address. I was wondering whether anyone has found a way to achieve this in the CRM much as the radius search in RECRUIT

• Zoho CRM Inventory Management

  What’s the difference between Zoho CRM’s inventory management features and Zoho Inventory? When is it better to use each one?

• Cannot Enable Picklist Field Dependency in Products or Custom Modules – Real Estate Setup

  Hello Zoho Support, I am configuring Zoho CRM for real estate property management and need picklist field dependency: What I’ve tried: I started by customizing the Products module (Setup > Modules & Fields) to create “Property Type” (Housing, Land, Commercial)

• Get Workflow Metadata via API

  Is there a way to get metadata on workflows and/or custom functions via API? I would like to automatically pull this information. I couldn't find it in the documentations, but I'm curious if there is an undocumented endpoint that could do this. Moderation

• Zoho Projects - Q2 Updates | 2025

  Hello Users, With this year's second quarter behind us, Zoho Projects is marching towards expanding its usability with a user-centered, more collaborative, customizable, and automated attribute. But before we chart out plans for what’s next, it’s worth

• FSM setup

  So we have been tinkering with FSM to see if it is going to be for us. Now is the time to bite the bullet and link it to our zoho books and zoho crm. The help guides are good but it would really help if they were a bit more in depth on the intergrations.

• Upcoming Updates to the Employees Module in Zoho Payroll (US)

  We've made a couple of updates to the Employees module in Zoho Payroll (latest version of the US edition). These changes will go live today. While creating an employee Currently, the Compensation Details section is part of the Basic Details step, where

• Possible to Turn Off Automatic Notifications for Approvals?

  Hello, This is another question regarding the approval process. First a bit of background: Each of our accounts is assigned a rank based on potential sales. In Zoho, the account rank field is a drop-down with the 5 rank levels and is located on the account

• ZOHO Creator subform link

  Dear Community Support, I am looking for some guidance on how to add a clickable link within a Zoho Creator subform. The goal is for this link to redirect users to another Creator form where they can edit the data related to the specific row they clicked

• Allow Resource to Accept or Reject an Appointment

  I have heard that this can be done, is there any documentation on how?

• Create new Account with contact

  Hi I can create a new Account and, as part of that process, add a primary contact (First name, last name) and Email. But THIS contact does NOT appear in Contacts. How can I make sure the Contact added when creating an Account is also listed as a Contact?

• Custom Fonts in Zoho CRM Template Builder

  Hi, I am currently creating a new template for our quotes using the Zoho CRM template builder. However, I noticed that there is no option to add custom fonts to the template builder. It would greatly enhance the flexibility and branding capabilities if

• Python - code studio

  Hi, I see the code studio is "coming soon". We have some files that will require some more complex transformation, is this feature far off? It appears to have been released in Zoho Analytics already

• Sync desktop folders instantly with WorkDrive TrueSync (Beta)

  Keeping your important files backed up and accessible has never been easier! With WorkDrive desktop app (TrueSync), you can now automatically sync specific desktop folders to WorkDrive Web, ensuring seamless, real-time updates across devices. Important:

• How To Insert Data into Zoho CRM Organization

  Hi Team I have this organization - https://crm.zoho.com/crm/org83259xxxx/tab/Leads I want to insert data into this Leads module, what is the correct endpoint for doing so ? Also I have using ZohoCRM.modules.ALL scope and generated necessary tokens.

• Where can I get Equation Editor por Zoho Writer?

  I need to use Math Formulas in my document. Thank you.

• How can I get base64 string from filecontent in widget

  Hi, I have a react js widget which has the signature pad. Now, I am saving the signature in signature field in zoho creator form. If I open the edit report record in widget then I want to display the Signature back in signature field. I am using readFile

• Creator roadmap for the rest of 2022

  Hi everyone, Hope you're all good! Thanks for continuing to make this community engaging and informative. Today we'd like to share with you our plans for the near future of Creator. We always strive to strike a good balance of features and enhancements

• Filtering repport for portal users

  Salut, I have a weird problem that I just cannot figure out : When I enter information as administrator on behalf of a "supplier" portal user (in his "inventory" in a shared inventory system), I can see it, "customer" portal users can see it, but the

• Zoho Inventory. Preventing Negative Stock in Sales Orders – Best Practices?

  Dear Zoho Inventory Community, We’re a small business using Zoho Inventory with a team of sales managers. Unfortunately, some employees occasionally overlook stock levels during order processing, leading to negative inventory issues. Is there a way to

• Zoho One - Syncing Merchants and Vendors Between Zoho Expense and Zoho Books

  Hi, I'm exploring the features of Zoho One under the trial subscription and have encountered an issue with syncing Merchant information between Zoho Expense and Zoho Books. While utilizing Zoho Expense to capture receipts, I noticed that when I submit

• Is Zoho Sheet available for Linux ?

  Is Zoho Sheet available for Linux ?

• Zoho Sheet for Desktop

  Does Zoho plans to develop a Desktop version of Sheet that installs on the computer like was done with Writer?

• BUTTONS SHOWN AS AN ICON ON A REPORT

  Hi Is there any way to create an action button but show it as an icon on a report please? As per the attached example? So if the user clicks the icon, it triggers an action?

• Dropshipping Address - Does Not Show on Invoice Correctly

  When a dropshipping address is used for a customer, the correct ship-to address does not seem to show on the Invoice. It shows correctly on the Sales Order, Shipment Order, and Package, just not the Invoice. This is a problem, because the company being

• RFQ MODEL

  A Request for quotation model is used for Purchase Inquiries to multiple vendors. The Item is Created and then selected to send it to various vendors , once the Prices are received , a comparative chart is made for the user. this will help Zoho books

• Will zoho thrive be integrated with Zoho Books?

  title

• Product Updates in Zoho Workplace applications | August 2025

  Hello Workplace Community, Let’s take a look at the new features and enhancements that went live across all Workplace applications this August. Zoho Mail Delegate Email Alias Now you can let other users send emails on your behalf—not just from your primary

• Notebook audio recordings disappearing

  I have recently been experiencing issues where some of my attached audio recordings are disappearing. I am referring specifically to ones made within a Note card in Notebook on mobile, made by pressing the "+" button and choosing "Record audio" (or similar),

• Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked

  Hi, I sent few emails and got this: Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked And now I have few days since I cant send any email. Is there something wrong I did? Also can someone fix this please

• Want to use Zoho Books in Switzerland. CHF support planned?

  Hi, We're a Swiss company using other Zoho suite software and I discovered Zoho Books and other accounting SaaS when looking for an accounting tool. Do you intend to cover Switzerland and CHF based accounting anytime soon? Roy

• Zoho sheet desktop version

  Hi Zoho team Where can I access desktop version of zoho sheets? It is important as web version is slow and requires one to be online all the time to do even basic work. If it is available, please guide me to the same.

• Weekly Tips : Teamwork made easy with Multiple Assignees

  Let's say you are working on a big project where different parts of a single task need attention from several people at the same time—like reviewing a proposal that requires input from sales, legal, and finance teams. Instead of sending separate reminders

• Best way to share/download presentation files in Zoho without losing formatting?

  Hello Zoho Community, I often work with PPT/PDF files in Zoho Docs and share them with colleagues. While PDFs usually give a direct download option, I’ve noticed that PPT/PPTX files sometimes only open in the viewer without a clear download link. Is there

• Next Page