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 #226: Using ZRC in Client Script
Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In thisKaizen #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 achieved
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
Unable to add attachments to tickets through Desk API
I able to use the Desk API to generate tickets. However when I try to use the tickets/{ticketId}/attachments endpoint, I always get an Unauthorized error. My app has Desk.Tickets.ALL included in its scope so this should not be an issueWhat's wrong with this COQL?
What's wrong with this COQL? Code returns "invalid operator found". SELECT id, Name, Stage, Account, Created_Time, Tag FROM Production_Orders WHERE (Account = '4356038000072566002' AND Stage NOT LIKE '%customer%') ORDER BY Created_Time DESC LIMIT 200[Feature Request] Add support for internationalized top-level domains mail hosting
This is an important request to add support for internationalized domains mail hosting to https://www.zoho.com/mail/ In this case, that is only limited to domain name/mail address however currently it's already possible for us send mails etc using belowAdd Enable/Disable to Field Rules and other Rules
Hi, Sometimes I have rules setup for fields, and until I want to enable them for use, I can set the fields to Hidden but rules still show them, today you have to delete rules and then recreate them again, would be nice to have a toggle for Enabled/DisabledSyncing stuck for days
Hello when I made an account a few days ago and synced all my notes to it, it is still syncing. My app is only 400mb so I do not know why it is taking so long. Please helpWorkflow runs on every edit despite not ticking the field repeat this workflow whenever a parent is edited.....
Hi, It is my understanding that this workflow should only trigger once. Why is this triggering on every edit of the field? Based on another support query - directly from Zoho, If i tick the box 'repeat this workflow whenever a parent is edited' it shouldHow do you add or update tags on Zoho CRM records via n8n? (Workarounds or best practices?)
Hi all, I’m running into some limitations with the Zoho CRM node in n8n and was wondering how others have handled this: From what I see, the standard Zoho CRM node in n8n doesn’t allow you to add or update tags when creating or updating contacts/leads.API PARAMETER FOR TICKET CLOSED TIME
Hi, Is there a parameter for filtering tickets by closed time in zoho api, i can see closed time in the API response i get, but can't get tickets by that field while calling. Regards, Anvin AliasReply to email addresses wrong.
I have setup my Zoho mail account using my main domain and I also have an Alias setup from a different domain. In Settings - Mail - Compose I have selected to the option "For replies, send using The same email address to which the email was sent to".Meeting integration with Otter.ai
Would love for an integration with an AI transcription service like Otter.ai to be integrated with Zoho Meeting. ThanksHow to close/delete a free creator account?
I have a free zoho creator account associated with my email address that is not being used. I want to become a user of another paid zoho creator account but I can not associate with the paid account with the same email. I assume if I can close or delete the free account I will be able to use the paid account. I have emailed support but no response. Suggestions?Zoho books and zapier causes Invalid data provided
I have been using zoho books with zapier for over 2 years now, everything was working fine. On September 13th my zaps stopped working. Now on step create sales invoice in zoho books i get an error: Failed to create a create_invoice_v2 in Zoho Books TheCRM report
Is it possible to pull a contacts report that also includes the company industry, as well as the company name? I’m having trouble combining company and contact fields – any help is appreciated. Thank you, SamEnhancements to Client script?
Hi Zoho CRM, I've been extensively using Client Scripts to enhance our Deal form experience, particularly for real time validations and auto updating fields based on specific logic. However, I've encountered a challenge regarding permission boundaries.Add views to new CRM UI navigation + Unlimited Webtabs
Zoho CRM is so close now to being the ultimate business application with the new UI, as soon as this one feature is added. This is probably where Zoho is headed but if it's not I want to BEG for this to be incorporated. What we need is to be able to putE-Mail Distribution List
How do I create an e-mail distribution list in Zoho Mail?Custom "create meeting" button with more functionality than Zoho currently has?
I'm looking for a little help/direction in how to do this. Even just some general high level pointers on how this might be able to be done. The current Zoho Meeting Activity functionality is not ideal for my org's workflow. I'd like to try and createError Code 4: Invalid value passed for JSONString
Okay, I want to start by saying I know I'm a terrible scripter, so sorry if this is a dumb mistake. I just can't figure it out, even with LLM help. Here's my code: // --- Input Variables --- customer_id = salesorder.get("customer_id"); so_id = salesorder.get("salesorder_id");Organizing contacts/members by company
I work for a membership organization (representing businesses) and am trying to use Zoho CRM more effectively for managing the points of contact for our members. Currently, our members are listed in our CRM by the primary point of contact's name, butUnable to search in Zoho Email
I've started using Zoho Email (free version) recently and realized that it doesn't have email search functionality. Am I missing anything here? I've gone through the Zoho tutorial which does show the search bar on the right top of the Zoho UI. But inResponse Time Report
From data to decisions: A deep dive into ticketing system reports Every organization that interacts with its customers should have an established timeframe for how soon an agent is expected to send the first response and any reply to any follow-up messages.Zoho - Outlook plugin
Does anyone know if there is a way to modify the autofill in the Zoho plugin in outlook? When we create a contact, it enters the correct email address and name, but then pulls information from our own signature line to add phone number, address, etc.Zoho Books - Sales Person Information
Hi Team, On Invoices, Quotes, etc... I can include the Sales Person, but it only shows their name and not their email or phone number. It would be great to have place on invoice templates where we can manage what sales person information should be showsOffline working in Zoho Creator portal
Zoho's help says that offline working is only available in the Creator mobile app and not in the portal app. But I can see offline options in the portal app too and it seems to work when I test it. My portal users are often in areas where there is poorFetch Records using Dynamic Criteria
Hi, I have a form that builds a filter based on user input. I need to fetch the records based on dynamic criteria. How would I accomplish this as there is no eval function? For example: desiredRecord = Form1[dynamicCriteria];Url filter Report date (pivot chart)
Hello. Is it possible to filter the data in pivot char using parameters in the url? I'm trying but I should not doing very well. Something like: https://creator.zoho.com/.../....../#Report:MyPivotChartReport?MyDate=01-Jan-2012;31-Jun-2012;MyDate_op=58 SaludosSending gmail to a particular person fails because the address gets changed to "gmaill", with a second "l" typo somewhere
I send to bob@gmail.com (example) and get an error sending to bob@gmaill.com, only for this one person. Note the extra "l" in the email the system tried to send to, which was not in the address I entered. Can't find a typo in the contact or anywhere elseEmoji Support in Bigin CRM
We request the implementation of emoji support across Bigin CRM. This feature should allow users to seamlessly use emojis in text fields, headlines, and deals. It would enhance communication, improve the visual appeal of records, and bring more personalizationBigin Booking Pages enhancements
I would like to ask for several enhancements for the brand new (and promising) Booking feature. 1. Add "Contact/Mobile" Field to Booking form We use Mobile as key (id), but unfortunately it is missing from the Booking form, only Home Phone is available.Amount in words in Indian format
Hi, I had coded the following code to convert amount in words. But in the code in the format of US like million. But i need in Lakh and Crore. So pls suggest ideas r post corrected code string Num2Words(int val) { val_s = input.val.toString(); th = {"", "thousand", "million", "billion", "trillion"}; // uncomment this line for English Number System // th = {"","thousand","million", "milliard","billion"}; dg = {"zero", "one", "two", "three", "four", "five", "six", "seven", "eight",What are people using to send Service based emails?
Zoho Campaigns is for marketing. Users can unsubscribe from these emails. Service based emails need to be delivered and can without the worry of Can-spam act. What are people using to send service based emails? My mailing list is derived from a databaseStandalone LMS tool
Will Zoho release a standalone LMS (Learning management System) than can be used by external parties (guest)?Announcing Kiosk 1.1 - Customize screen titles, configure new fields & actions, use values from your Kiosk to update fields, and more.
Hello all We are back again with more enhancements to Kiosk. So what's new? Enhancements made to the Components Add titles for your Kiosk screens and adjust its width to suit your viewing preferences. Three new fields can be added to your screen: Percentage,An Overview of Dario Schiraldi Deutsche Bank Executive
Hello Community, Dario Schiraldi is an executive at Deutsche Bank, focused on advancing the firm’s financial services and crafting its global strategic vision. With 20 years of expertise in leadership roles, he has spearheaded successful market acquisitionsEmailing a document to WorkDrive
Does WorkDrive include the ability to upload a document by sending an attachment to an email address? (Books and Expenses include this functionality) If it doesn't is it under consideration? on the Road Map?Allow Changing Appointment Status from "Completed" to "No Show" or Other Valid States
Hi Zoho Bookings Team, We hope you're doing well. We would like to submit a feature request regarding appointment status management in Zoho Bookings. 🎯 Use Case Sometimes, an appointment is mistakenly marked as Completed, but later we realize that theZoho One and Tally Integration
Has Anyone in this forum done any implementation with Zoho CRM and Tally accounting software. If so who have you used and how easy was it?Microsoft PowerPoint files Extremely slow to save
I and others on my team have noticed that Microsoft PowerPoint documents are extremely slow to save when using WorkDrive. It always takes over 30 seconds to save a file. Word and Excel files seem to save in a typical length of time, but PowerPoint isHow can users unblock their blocked Zoho Mail accounts?
After the reason for the account block (storage exceeded, spam detection etc.) has been rectified, the user can unblock the account from the UnBlock Me page. Account support@edu2review.com Edu2Review is an education review platform, we rate the qualityAdding additional fields for batch information
Hello, I am looking at adding additional information into our inventory module. we would like to be able to see up to 8 attributes that will be individual & different for each batch (i.e. batch specific information) but currently I seem to only be ableNext Page