Kaizen #17 - PHP SDK
Hello everyone!
Welcome to yet another post in the Kaizen series.
PHP Software Development Kit
PHP SDK allows you to create client PHP applications that can be integrated with Zoho CRM effortlessly. It serves as a wrapper for the REST APIs, thus making it easier to use the services of Zoho CRM.
Here is a sample of how the PHP SDK acts as a middleware between Zoho CRM and Client PHP Application.
What can you do with the PHP SDK?
- You can use the PHP SDK to exchange data between Zoho CRM and the client PHP application.
- Authenticate your application easily every time you sync data between Zoho CRM and the client PHP application, as the SDK takes care of generating the access/refresh tokens automatically.
Installing the PHP SDK
You can install the PHP SDK for Zoho CRM through the Composer—a dependency manager for PHP applications.
The pre-requisites for the client PHP application, before you start using the PHP SDK are:
- The client app must have PHP 5.6 or above with a curl extension.
- The client app must have the PHP SDK installed through Composer.
- The ZCRMRestClient::initialize($configuration) function must be called once while starting the client app. It contains the configuration details as key-value pairs.
PHP SDK and the PHP client application
- Include the following line to your client application (wherever you intend to use the PHP SDK) to access all the functionalities of the PHP SDK.require ‘vendor/autoload.php’
- Include the namespaces of the class in the "use" statement. For instance, if you use the ZCRMRestclient class, you must add the following.use zcrmsdk\crm\setup\restclient\ZCRMRestClient;
How to start using the PHP SDK?
- Step-1: Prerequisite: Register your application
- Step-2: Install the PHP SDK
- Step-3: Authenticate the client application
- Step-4: Knowledge Base: Token Persistence
- Step-5: Initialization
Step-1: Prerequisite: Register your application
All the Zoho CRM APIs are authenticated by the OAuth2.0 standards. It is mandatory to authenticate the client application with Zoho.
2. Click ADD CLIENT.
3. Choose a client type. For instance, Self Client.
4. Choose the Client Type, and click CREATE.
In the case of a web-based client, you need to specify the Client Name, Homepage URL and redirect URIs. 
5. Once you successfully register your self-client, you will receive a Client ID and Client Secret.
Step-2: Install the PHP SDK
Installing Composer
As discussed earlier, you can install the PHP SDK through the Composer. To install the composer:
Operating System | Procedure |
Mac/Linux | Run the following command in your terminal: curl -sS https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx |
Windows | Click here to download the .exe file and install composer. |
Installing the PHP SDK through the Composer
- Navigate to the workspace of your client app.
- Run the following command in the workspace of your client app.composer require zohocrm/php-sdk
- Once you run this command, the system installs the PHP SDK and creates a package named vendor in the workspace of your client app.
Step-3: Authenticate the client application
You must authenticate the client PHP application before it can use the PHP SDK. To authenticate the client PHP application, pass the configuration associative array to the initialization process.
- Create $configuration associative array. It must contain the authentication credentials required.
- The configuration associative array must then be passed using the ZCRMRestClient::initialize($configuration); function.
Configuration associative array
You must add the configuration values to the PHP associative array (key-value pair) and pass it as an argument to the ZCRMRestclient::initialize($configuration); function. Below is the list of keys that are to be in the associative array.
Key | Description |
client_id, client_secret mandatory | You can get these details after registering your client. |
redirect_uri mandatory for a web based client | The redirect URI of your web-based PHP client application. |
currentUserEmail mandatory | It is the email ID of the current user. You can set it in two ways: a. Through the currentUserEmail key in the configuration associative array (or) b. Through the ZCRMRestClient::setCurrentUserEmailId({user_email_id}) line in the code. |
fileUploadUrl Mandatory when using the Bulk Write API | The value for this key must be https://content.zohoapis.com. |
applicationLogFilePath optional | The SDK automatically creates a file to store the log information. The absolute file path of the folder in which the system must create the log file must be specified. The default file name is the ZCRMClientLibrary.log. If not specified, the system creates the file inside the project. |
sandbox optional | Represents whether to make API calls from the sandbox account. true: Make the API calls from the sandbox account. false: Do not make the API calls from the sandbox account. This is the default value. |
apiBaseUrl optional | Represents the URL to make API calls. It denotes the domain of the user. The possible values are: www.zohoapis.com (default) www.zohoapis.eu www.zohoapis.com.cn |
apiVersion optional | Represents the API version. Specify the value as v2 (default). |
access_type optional | Specify the value as offline. There is no support for Online OAuth client in PHP SDK as of now. |
accounts_url optional | The accounts URL. Possible values are: https://accounts.zoho.com (default) |
persistence_handler_class optional | The implementation of ZohoOAuthPersistenceInterface |
token_persistence_path optional | The absolute path to the folder that contains zcrm_oauthtokens.txt file. This key is mandatory if you want to use file persistence. If you include this key, this method takes precedence over other persistence methods. |
persistence_handler_class_name optional | The name of the custom class for persistence. This key is available only in PHP SDK 2.0.7 and above versions. |
db_port optional | You can specify this key if you want to use DB persistence. The default value is 3306. |
db_username, db_password optional | Specify the username and password of your database. The default value for db_username is root. |
host_address optional | The address of the machine in which the MySQL server is running. The default value is 'localhost'. This key is available only in PHP SDK 2.0.7 and above versions. |
Sample containing the mandatory keys alone:
$configuration=array("client_id"=>"1000.xxxxxxxxxxx"","client_secret"=>"831bxxxxxxxxxxxx","redirect_uri"=>"","currentUserEmail"=>"patricia@zylker.com"); ZCRMRestClient::initialize($configuration); |
Sample containing all the keys:
$configuration=array("client_id"=>"1000.xxxxxxxxxxx", "client_secret"=>"831bxxxxxxxxxxxx", "redirect_uri"=>"redirect_uri", "currentUserEmail"=>"patricia@zylker.com", "applicationLogFilePath"=>"absolute/path/to/folder", "sandbox"=>"false","apiBaseUrl"=>"www.zohoapis.com", "apiVersion"=>"v2","access_type"=>"offline", "accounts_url"=>"https://accounts.zoho.com", "persistence_handler_class"=>"absolute/file/path/to/persistence/implementation", "token_persistence_path"=>"absolute/path/to/folder/zcrm_oauthtokens.txt", //should not contain "zcrm_oauthtokens.txt" "persistence_handler_class_name"=>"Persistence_class_name", "fileUploadUrl"=>"https://content.zohoapis.com"); ZCRMRestClient::initialize($configuration); |
Step-4: Token Persistence
Your application should retain tokens (grant, access, refresh tokens) to automate the process of data-sync between your PHP application and Zoho CRM.
You can persist tokens in your application in three ways:
- a. Using a Database
- b. Using a File
- c. Custom Persistence
a. Using a Database
If you prefer using database persistence, you can use the MySQL.
Prerequisites while using the database persistence
- The name of the database must be zohooauth.
- There must be a table oauthtokens with columns
a. useridentifier (varchar(100))
accesstoken (varchar(100))
refreshtoken (varchar(100))
expirytime (bigint)
b. Using a File
This type of persistence uses a file to read and write OAuth tokens. The file persists the token of a single user. So, it is best used for the 'self-client' type of authentication since it involves only one user. If you prefer using the file persistence, you must create an empty file in the local drive named zcrm_oauthtokens.txt. Further, set the file path in the token_persistence_path, of the $configuration associative array. Do not include "zcrm_oauthtokens.txt" in the path.
For example, if the file is in a folder named "TokenStorage", then
token_persistence_path="{path/to/TokenStorage}"
c. Custom Persistence
From the PHP SDK version 2.0.0, you can have your own implementation of persistence.
You must mention the name of the persistence class in the persistence_handler_class_name key of configuration associative array. Provide the file path of the PHP file that implements the custom persistence, in the persistence_handler_class key of the configuration associative array. The class must implement the ZohoOAuthPersistenceInterface.
You must write an implementation of the inbuilt ZohoPersistenceHandler interface, with the following methods:
- getOAuthTokens($userEmailId)—invoked to fetch the saved tokens. This method should return ZohoOAuthTokens object for the library to process it.
- saveOAuthData(ZohoOAuthTokens tokens)—invoked to store the tokens.
- deleteOAuthTokens($userEmailId)— invoked to delete the tokens.
Step-5: Initialization
Once you define the OAuth configuration, you can initialize the PHP client application.
You need to generate the tokens (grant/access/refresh) to run the app.
Generating the tokens
As the V2 Zoho CRM APIs follow the OAuth2.0 protocol, it is mandatory to authorize the OAuth2.0 app before using the SDK functions with an access token.
You can generate an access token from a grant token.
You can generate the grant token in two ways based on the type of client.
For Self Client Applications
- Log in to Zoho and go to Zoho Developer Console.
- Select your Self Client.
- Provide the necessary scopes separated by commas, along with the scope aaaserver.profile.READ.
- Select the Time Duration from the drop-down. This is the time the grant token is valid for.
- Provide a description for the scopes. Click GENERATE.
- Copy the grant token.
For Web-based Applications
It is the responsibility of your client app to generate the grant token for the users trying to login.
Your application's UI must have the Login with Zoho option to open the grant token URL of Zoho, which would prompt for the user's OAuth2.0 authorization.
Upon the successful login of the user, the grant token will be sent as a parameter to your registered redirect URL.
Generating an access token from the grant token
Use the below code snippet in your main class.
$configuration =array("client_id"=>"1000.xxxxxxxxxxx","client_secret"=>"831bxxxxxxxxxxxx","redirect_uri"=>"","currentUserEmail"=>"patricia@zylker.com"); ZCRMRestClient::initialize($configuration); $oAuthClient = ZohoOAuth::getClientInstance(); $grantToken = "paste_the_self_authorized_grant_token_here"; $oAuthTokens = $oAuthClient->generateAccessToken($grantToken); |
Note
- The code snippet to generate the access token from the grant token is valid only once per grant token. If the grant token expires before you generate the access token, you must generate a new grant token only.
- Generating access and refresh tokens is a one-time process. After the tokens are generated for the first time, the SDK persists them based on the keys defined in the configuration dictionary, and refreshes the access token as and when required.
App Startup
Invoke the following line of code every time you start your client app.
$configuration =array("client_id"=>"1000.xxxxxxxxxxx","client_secret"=>"831bxxxxxxxxxxxx","redirect_uri"=>"","currentUserEmail"=>"patricia@zylker.com"); ZCRMRestClient::initialize($configuration); |
Sample SDK Code
The following image shows the sample SDK code to create a new record. The downloadable sample code is attached.
For more sample codes, refer to our SDK guide.
We hope you found this post useful. Keep a tab on this series for more exciting topics!
Reach out to us at support@zohocrm.com if you have any questions, or let us know in the comment section.
We will meet you next week with another useful topic.
Cheers!
Access your files securely from anywhere
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Shylaja S
Jonathan Thirkill
Praveen Sankar
Momin
Pardha Teja M
Sticky Posts
Kaizen #222 - Client Script Support for Notes Related List
Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore howKaizen #217 - Actions APIs : Tasks
Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.Kaizen #216 - Actions APIs : Email Notifications
Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes areKaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achievedKaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script
Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
Tags get removed from notes on mobile
I don't know why this keeps happening even after all these app updates but if you log out and log back into the app or you reinstall it, all the tags you assigned to your notes get taken off, but if you go on the desktop version the tags are still there.VAT rates - exempt and out of scope
Good Evening, UK based company here. I am a bit confused in respect of setting up VAT rates for exempt goods and services; at present I am simply leaving the VAT rate blank in the transactions in order to prevent any VAT appearing in the VAT return. WhenIntroducing Lead Capture: Empower exhibitors to capture leads effortlessly
Events provide a great opportunity for exhibitors to generate awareness and engage with potential customers. Efficiently distributing attendee information to exhibitors through a seamless and secure way is of paramount importance. Introducing Lead CaptureWork Order Creation Issue
Dear Team, I would like to inquire about the daily limit for Work Order creation in Zoho FSM. Yesterday (02/05/2025) at around 6:30 PM GST, I attempted to create a Work Order, but I have been unable to do so since then. Please find the attached imageConvert invoice from zoho to xml with all details
How to convert an Invoice to XML format with all detailsURGENT: ChatGPT Extension Failing With “gpt-3 Access Error” (Priority Support)
Appreciate support reviewing this urgently. I am a Priority Support member and need immediate clarification on a recurring issue involving the ChatGPT extensions inside Zoho Desk. Both extensions — including the version created and published by Zoho —Zoho Desk iOS update: Custom buttons, follow/ unfollow option on tickets
Hello everyone! In the most recent Zoho Desk iOS app update, we have brought in support to access the custom buttons configured on web app(desk.zoho.com). Using custom buttons you can seamlessly execute predefined actions directly from their mobile devices,Zoho pdf suit
Pl. design products with following feature: 1. Please add all features given in Ilovepdf website to work on pdf files. It is mandatory to use pdf in court work. 2. Courts have prescribed New Times Roman, pl. add this font as well 3. Indexing, signatureZoho Not Working
Today Zoho not wokringDynamically autofill fields with URL parameters
I have a zoho form embedded in my organization's WP website. Our users find their account with a search tool, and then can select to open this page with the embedded form. The URL of the page holds the parameter that I need, but I cannot figure out howIntegrate Projects for Desk KB article release tasks
Could you please look into the possibility of integrating project tasks for Zoho Desk article release processes? We are looking for an internal integration between Zoho Projects and Zoho Desk's KB article drafting, reviewing and releasing tasks. We couldIssue in Annual Leave
We created a policy to credit 21 days at the Start of the Year An employee has taken 16 days of leaves thought the year, so we expect to see 5 Leaves remaining right? But Zoho People is Showing 12 Days of Leave Balance Available If we check the LeaveUse the searchBy parameter to find user by email address
I'm trying to find a user is Zoho Desk via the Api. In the documentation I see that there is the possibility to add a searchBy parameter in the request. But I can't find how the search values should be formatted. I've tried multiple things and get eitherZoho CRM Community Digest - September 2025 | Part 2
Hello Everyone! Mid-September vibes: fresh tips, smart hacks, and practical Zoho CRM updates all in one place. Let’s dive in. Product Updates: The All-New Address Field! The new Address field type makes it easier to capture complete addresses in one structuredZoho Vault API: Create new Secrets
Hello, I attempt to Post Secrets to the vault, since the encrypted entries are almost impossible to decrypt, since there is no documentation on how to decrypt them. Like with the lack of documentation on how to descrypt, there are missing information regarding on how to create new secrets/post secrets. Source: https://www.zoho.com/vault/api/#create-a-new-secret When I try to send JSON Informationen as a POST-Request I only receive the error message: { "operation": { "result": { "error_code": "",CRM and Finance Tab - Add Invoice "Subject " Column
When On a contact in CRM, and you click the Zoho Finace tab, how can I put in the invoice subject line? Or even a custom field for this. We need to see what that invoice is for, without opening it. If we have tons of invoices we need a way to quickCollections Management: #4 Before, During & After Payment Processing
"Mark, I think the payment link isn't working. Can you send it again?" Staring at a message, Mark got on his phone. This was the third time the same customer had asked him that week. A few minutes later, another message came, "Hey, the invoice total seemsAccount name not populating when importing contacts
When importing a csv file to add contacts the account name is blank? Every other filed gets mapped and imported correctly, i.e contact name, phone number. However not the account name which I have mapped to "company" field in my csv fileSuggestion to improve zoho writer
I am using your product, I believe it is very useful, however, i was writing a note and I needed to draw an arrow in different angles to explain a point and I couldn't. it would be helpful, to add draw functions to the zoho writer. thankswebhook basic authentication
II want to use a webhook to send out a SMS. Unfortunately Twilio does not use an authToken but basic authentication. I created the webhook as POST and get this url: https://{username}:{password}@api.twilio.com/2010-04-01/Accounts/{account}/Messages?body=<BODY>&to=+155555555&from=+1555555555Custom function return type
Hi, How do I create a custom deluge function in Zoho CRM that returns a string? e.g. Setup->Workflow->Custom Functions->Configure->Write own During create or edit of the function I don't see a way to change the default 'void' to anything else. AddingIssue with Hour Calculation in Zoho People Attendance Module
I have noticed an issue in the attendance regularization feature of Zoho People. When trying to regularize past dates, the total working hours are not calculated correctly. For example, if I enter a check-in and check-out time for a previous day, thePush Notification for New Bookings in Zoho Bookings App
when a someone schedules an appointment through the booking page, is there any option to receive a push notification in the mobile app?Automation in Zoho Sprints
Hi. I have a Sprints board with the following statuses: ToDo, InProgress, CodeReview, Testing, Preprod, Live When a ticket is moved from e.g. Testing to Preprod, the following tags should be modified: remove 'tested OK' remove 'ready for Preprod' addExport Purchase orders as Excel
Is it possible to export purchase orders as excel rather than PDF? Our suppliers don't want orders made in PDF, they need it to be excelDraft & Schedule Emails Directly in Bigin
Greetings, I hope all of you are doing well. We're happy to announce a few recent enhancements we've made to email in Bigin. We'll go over each one in detail, but here's a quick overview: Previously, you couldn't draft or schedule emails in Bigin, butTDS Filing
Is there any option for automatic 26Q and 24Q filing in Zoho books. Even Tally has this option. Why don't Zoho has this ? Is there any customisation available for this ?Create CRM Deal from Books Quote and Auto Update Deal Stage
I want to set up an automation where, whenever a Quote is created in Zoho Books, a Deal is automatically created in Zoho CRM with the Quote amount, customer details, and some custom fields from Zoho Books. Additionally, when the Sales Order is convertedZia’s AI Assist now helps you write clearer notes — in seconds
After helping recruiters craft job descriptions, emails, and assessments, Zia’s AI Assist is now stepping in to make note-taking effortless too. Whether you’re recording feedback after an interview or sharing quick updates with your team, you can nowShortcut to fill a range of cells
Good evening: I'm writing because I haven't been able to find a feature that allows you to select a range of cells, type in one of them, and then use a key combination to type in all of them. In Excel, the keyboard shortcut is Ctrl+Enter. I haven't foundObject required error
Hi, I am getting an 'Object required' error on the line Call HideColumnsOutsideRange(ws, startOfWeek, endOfWeek) when I run the ShowCurrentWeek macro but not when I run the ShowCurrentMonth macro. Any ideas? Regards, GW Option Explicit Sub HideColumnsOutsideRange(wsZoho CRM - Rename "Estimates" in CRM Finance Suite Integration to "Quotes"
I'm not sure if it's been 2 or 3 years now since Zoho Books renamed Estimates to Quotes. I still see "Estimates" in the Zoho CRM integration. Could this be added to Translation settings so that some customisation could be made on an account by accountIts 2022, can our customers log into CRM on their mobiles? Zoho Response: Maybe Later
I am a long time Zoho CRM user. I have just started using the client portal feature. On the plus side I have found it very fast and very easy (for someone used to the CRM config) to set up a subset of module views that make a potentially extremely usefulNew Series Announcement - Ecommerce Marketing Tips
Running an online business is more than just having a website. It’s about getting the right customers to discover you, trust you, and keep coming back. To support your growth journey, we’re launching a weekly Marketing Tips series right here on Zoho CommerceMarketing Tip #7: Add a blog to your online store
A blog is more than content. It’s a magnet for new customers. Sharing product guides, styling tips, or industry insights through blog posts builds trust and helps you rank higher on search engines. Try this today: Write one blog post answering a commonKanban 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 givenAllow Regular Users to Directly Transfer Ownership of Files & Folders
Hi Zoho WorkDrive Team, Hope you are doing well. We would like to request an important enhancement related to file and folder ownership management in Zoho WorkDrive. At the moment, a regular user cannot directly transfer ownership of their files or foldersTriggering rules on lead conversion
There is no field on the Rule list for rule conversion to trigger an alert on liead conversion to a potential. I assigned a rule to file on any creation or update of a lead. The lead was changed a lead to a potential but no rule was fired. Rajesh BhadraCustomised Funnel
We are running the standard plan for our ZOHO CRM. I have been asked if there is a way to combine data from the Calls module, Deals module and Contact Module into 1 funnel, similar to the view you can get when viewing Deals By Stages, you can see theTrigger Zapier on Deluge Insert Into Function?
Hello, To get around the limitation of not being able to trigger a Zapier Zap on Record Update(this would be extremely useful to be able to do btw), I have created a Deluge script to copy the data from Form A to a Trigger Form B using the Insert Into expression from a Custom Action button on a Report from Form A. This action does not trigger the Zapier Zap whereas manually adding a record or duplicating an existing record does trigger the Zap. Is Insert Into not the same as a manual Add in the contextNext Page