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

• Time Entry Notifications

  Hi All - I have support staff who place notes of their work in the time entry section of Zoho Desk. Is there a specific workflow or setting I need to enable to have the ticket holder updated via email when an entry is saved?

• How to report 'Response violation' OR 'Resolution violation'

  Hi, I want to report on SLA Violation Type. I grouped my tickets on this column. It seems I only get 'Response and Resolution Violation' or 'Not Violated'. The former seems to be given to a ticket if only the Response Time was violated. I would expect

• [Webinar] Automate sales and presales workflows with Writer

  Sales involves sharing a wide range of documents with customers across the presales, sales, and post-sales stages: NDAs, quotes, invoices, sales orders, and delivery paperwork. Generating and managing these documents manually slows down the overall sales

• Power of Automation :: Quick way to associate your Projects with Zoho CRM

  A custom function is a software code that can be used to automate a process and this allows you to automate a notification, call a webhook, or perform logic immediately after a workflow rule is triggered. This feature helps to automate complex tasks and

• Date triggering Workflow rule

  I have a function triggered by a workflow rule. The function takes a date and creates a task for that date and fills in a field with the name of the day for that date. It also updates the status field of the record. The workflow rule is set to run whenever

• Restricting contact creation

  Hi all! I am looking to use Zoho Desk in a part of the business that takes end user enquiries. These are generally single interactions, and not linked to an account name. As Desk is Account centric, has anyone designed a way to manage these incoming emails

• Import Holiday Calendars

  HI Zoho Is there anyway of importing an online calendar like https://www.calendarlabs.com into the business hours calendars, to speed up setup of holiday calendars. Also could we also request a feature where you can specify a Holiday as hours, i.e it could be that the company is on a 1/2 day due to a holiday or when it is Eid in the UAE and they are only allowed to work restricted hours so we need the calendar to be flexible to allow for this. Regards Jamie

• Filtering Tickets based on Email headers

  We're starting to get a lot more junk coming into our Zoho Desk, which is then triggering unnecessary email alerts to agents. Once thing we could do to cut this junk in half, is to filter tickets based on email headers. Any email containing the `List-Unsubscribe`

• Error 550 5.4.1

  I’ve tried sending an email to someone but keep receiving this back. Any help would be greatly appreciated 

• Billing Management: #2 Fair way of Billing- Prorated Billing

  Hello, From speaking about the traditional ways of billing in the previous post, we are moving into the deep sea of billing. We are now in a zone to break out the most complex yet, I would call it the fairest way of billing, the Prorated Billing. Prorated

• Has Anyone successfully integrated Zoho and Sage Intact?

  Hey all, We’re evaluating Zoho One + Sage Intacct and I’m trying to connect with anyone who has actually implemented the two together.Specifically, I’d love to know: -- Which functions you kept in Zoho vs. Intacct (e.g., Product Catalog, AR/AP, invoicing,

• How can I filter a field integration?

  Hi,  I have a field integration from CRM "Products" in a form, and I have three product Categories in CRM. I only need to see Products of a category. Thanks for you answers.

• Adding image in HTML report page

  Hi, I want to know two things: 1. Can anyone advise how to add an image in HTML report. The tagged used is <img> but what path do I mention for the image to be added in the HTML report. 2. Also, I want to know if I am creating an application for the market

• How to change view of HTML report based on device but always print in A4

  Hello everyone, I am aware that HTML report view can be configured to adjust according to the screen size like Laptop, Tablet and mobile using media queries. But my concern is no matter on which device the reports is opened when printed should always

• Age Calculation

  I've attempted to calculate the age of someone based on their birthday input by using the formula field. It works but I don't want all those decimals on there. I then tried to use "set variable" after birthday input but I get a field type mismatch, long vs. floating. Any ideas would be wonderful.

• Search on Custom Field

  We're working on an integration with the Zoho FSM API and are trying to retrieve companies based on a custom field we added to the Companies module. However, we can't find a way to filter or query records using custom fields through the API. We have a

• Sendmail function / custom action?

  I've setup a function hoping to email various business departments the details of a record once all work in that record is complete so gone about setting up a custom action in such way that each record line on the report has a button to click. Question is how do I actually include data from that record in the email that is sent when the button is clicked? I had thought that since this were being sent per record the email would include the data which had been entered

• API to post drafts for social media

  I we want to post draft posts to our zoho social account and then approve and schedule them within Zoho social. is this possible with for example: https://apis.zoho.com/social/v2/post TIA Jon

• Canvas View in Zoho Recruit

  Is it possible or would it be possible to have the new 'Canvas View' in Zoho Recruit?

• What impactful sales coaching techniques have you used to boost your team's performance?

  I'm curious about the real-world impact of sales coaching on team performance. What specific techniques or strategies have you found most effective in driving consistent improvement and growth in your sales team? Any success stories or lessons learned

• Adding Taxes to paid consultations in Zoho Bookings

  I created a 'paid' consultation under Zoho Booking and integrated it with payment gateways for online/instant payment before a booking is done. How can I add 'taxes' to the price of consultation? I can add taxes to other Zoho apps (liks Books, Checkout,

• Zoho Finance Suite - Customer Custom Tabs - Dynamic Link

  Hi Finance Suite team, When creating a Custom Tab for a Client Portal, there is no option to add dynamic parameters. This would be very helpful for adding Zoho Analytics dashboards which can be dynamically filtered through the URL to only show information

• Possible to bold or indent text in the description field?

  As part of one item, I often have a detailed description that would be much easier to read if there was the ability to have a bulleted list or bold text and the like. Is this possible? My last invoicing software allowed markup in the field so, for example, an asterisk meant a bullet. I haven't been able to find any documentation related to this.  Any information would be appreciated. Thank you.

• How can I setup Zoho MCP with Chat GPT

  I can set up custom connections with Chat GPT but I cat an error when I try to set it up. The error is: "This MCP server can't be used by ChatGPT to search information because it doesn't implement our specification: search action not found" Thoughts?

• Formatting of Balance Sheet and Profit & Loss Reports

  The default format of the Balance Sheet and P&L Reports are based on the Account Types and then the individual accounts within the Chart of Accounts. These are then ordered alphabetically under these sub-headings and one is unable to re-order these or

• UK MTD reports concerning turnover and cerash accounting

  Hi I am a sole trader, and I have just started with Zoho Books in order to comply with the new HMRC requirements. I use 'cash basis' - which I understand to mean that income is when the cash comes in (not the invoice date) and expenses are when they are

• Retainer Invoice.

  Why ZOHO not have facilities to deduct partially advance payment from an invoice.

• IMAP Server not responding.

  Trying to connect a phone via IMAP and getting "imap.zoho.com not responding." Is the server down, for maintenance or otherwise? I've tried this on two different devices and got the same error on both.

• Share saved filters between others

  Hi, I am in charge to setup all zoho system in our company. I am preparing saved filters for everybody, but the only one can see its me. How can others see it? Thanks

• GST Slabs Redefined: Stay Compliant Using Zoho Books!

  Hello Everyone! The Government of India is rolling out new GST rates, a major reform aimed at simplifying the current tax structure starting 22 September 2025. GST will move from four slabs (5%, 12%, 18%, 28%) to two main slabs (5% and 18%), plus a special

• Kanban view on Zoho CRM mobile app!

  What is Kanban? The name doesn't sound English, right? Yes, Kanban is a Japanese word which means 'Card you can see'. As per the meaning, Kanban in CRM is a type of list view in which the records will be displayed in cards and categorized under the given

• Presenting ABM for Zoho CRM: Expand and retain your customers with precision

  Picture this scenario: You're a growing SaaS company ready to launch a powerful business suite, and are looking to gain traction and momentum. But as a business with a tight budget, you know acquiring new customers is slow, expensive, and often delivers

• No practical examples of how survey data is analyzed

  There are no examples of analysis with analytics of zoho survey data. Only survey meta data is analyzed, such as number of completes, not actual analysis of responses, such as the % in each gender, cross-tabulations of survey responses. One strange characteristic

• Zoho Creator as LMS and Membership Solution

  My client is interested in using Zoho One apps to deploy their membership academy offer. Zoho Creator was an option that came up in my research: Here are the components of the program/offer: 1. Membership portal - individual login credentials for each

• Adding Chargebee as a Data Connector

  Is it possible to get Chargebee added as a Zoho Analytics data connector?

• Webform & spam

  Hi, We set up 2 webform on our website, fowarding the content to Zoho CRM. Since it has been opened up, we are getting lot of spam message (for now about 20 a day). To lower the  amount of false new leads we added the captcha field and new enquieries are send to the Approval Leads list. However we still get some spam. Is there any "anti spam" mechanism built in Zoho CRM, or how is the best way to avoid these kind of spam ? Thanks

• Dropbox to Workdrive

  Namaste, Trust you all are doing well. Wanted to check how this can be done with Zoho flow. I typically receive dropbox links from my clients. Is there a way where I can provide the link to Zoho flow and it downloads the files from dropbox link to a work

• Deals by Stages Funnel not showing in correct order

  Using the Stage-Probability Mapping for the Deals module we have created a steps our deals will pass through, RFQ, Closed/Lost, Declined/No-Go, Pricing, Submitted, Negotiations, Won. However when I view the Deal By Stages Funnel it does not show in the

• Turning off the new UI

  Tried the new 'enhanced' UI and actively dislike it. Anyone know how to revert back?

• Confirmation prompt before a custom button action is triggered

  Have you ever created a custom button and just hoped that you/your users are prompted first to confirm the action? Well, Zoho knows this concept. For example, in blueprint, whenever we want to advance to the next state by clicking the transition, it is

• Next Page