Download the PHP package zohocrm/php-sdk-2.1 without Composer

License

Copyright (c) 2021, ZOHO CORPORATION PRIVATE LIMITED 
All rights reserved. 

Licensed under the Apache License, Version 2.0 (the "License"); 
you may not use this file except in compliance with the License. 
You may obtain a copy of the License at 

    http://www.apache.org/licenses/LICENSE-2.0 

Unless required by applicable law or agreed to in writing, software 
distributed under the License is distributed on an "AS IS" BASIS, 
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
See the License for the specific language governing permissions and 
limitations under the License.

ZOHO CRM PHP SDK 2.1 for API version 2.1

Table Of Contents

• Overview
• Registering a Zoho Client
• Environmental Setup
• Including the SDK in your project
• Persistence
  • DataBase Persistence
  • File Persistence
  • Custom Persistence
• Configuration
• Initialization
• Class Hierarchy
• Responses And Exceptions
• Multi User and Multi DC support in the PHP SDK
• Sample Code

Overview

Zoho CRM PHP SDK offers a way to create client PHP applications that can be integrated with Zoho CRM.

Registering a Zoho Client

Since Zoho CRM APIs are authenticated with OAuth2 standards, you should register your client app with Zoho. To register your app:

• Visit this page https://api-console.zoho.com/

• Click ADD CLIENT.

• Choose the Client Type.

• Enter Client Name, Client Domain or Homepage URL and Authorized Redirect URIs then click CREATE.

• Your Client app will be created.

• Select the created OAuth client.

• Generate grant token by providing the necessary scopes, time duration (the duration for which the generated token is valid) and Scope Description.

Environmental Setup

PHP SDK is installable through Composer. Composer is a tool for dependency management in PHP. SDK expects the following from the client app.

• Client app must have PHP(version 7 and above) with curl extension enabled.

• PHP SDK must be installed into client app though Composer.

Including the SDK in your project

You can include the SDK to your project using:

• Install Composer (if not installed).

  • Run this command to install the composer.

  • To install composer on mac/linux machine:

  • To install composer on windows machine:

• Install PHP SDK.

  • Navigate to the workspace of your client app.

  • Run the command below:

  • The PHP SDK will be installed and a package named vendor will be created in the workspace of your client app.

• Using the SDK.

  • Add the below line in PHP files of your client app, where you would like to make use of PHP SDK.

  Through this line, you can access all the functionalities of the PHP SDK. The namespaces of the class to be used must be included within the "use" statement.

Token Persistence

Token persistence refers to storing and utilizing the authentication tokens that are provided by Zoho. Token persistence enables the SDK to automatically refresh the access token after initialization using the refresh token without the need for user intervention. There are three ways provided by the SDK in which persistence can be applied. They are file persistence, DB persistence and Custom persistence. Please note that the default method of token persistence provided by the Zoho CRM SDK is File persistence.

Table of Contents

• DataBase Persistence

• File Persistence

• Custom Persistence

Implementing OAuth Persistence

Once the application is authorized, OAuth access and refresh tokens can be used for subsequent user data requests to Zoho CRM. Hence, they need to be persisted by the client app.

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

• getToken($user, $token) - invoked before firing a request to fetch the saved tokens. This method should return an implementation of Token interface object for the library to process it.

• saveToken($user, $token) - invoked after fetching access and refresh tokens from Zoho.

• deleteToken($token) - invoked before saving the latest tokens.

• getTokens() - The method to retrieve all the stored tokens.

• deleteTokens() - The method to delete all the stored tokens.

• getTokenById($id, $token) - This method is used to retrieve the user token details based on unique ID.

Note:

• $id is a string.

• $user is an instance of UserSignature.

• $token is an instance of Token interface.

DataBase Persistence

Database persistence is a technique that involves storing and retrieving data from a database. In case the user prefers to use the default DataBase persistence, MySQL can be used.

• The database name should be zohooauth.

• There must be a table named oauthtoken with the following columns.

  • id varchar(255)

  • user_mail varchar(255)

  • 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)

Note:

• Custom database name and table name can be set in DBStore instance

MySQL Query

Create DBStore object

File Persistence

File persistence is a simple approach for storing and retrieving data that is saved to a file on local drive. In case of default File Persistence, the user can persist tokens in the local drive, by providing the the absolute file path to the FileStore object.

• The File contains

  • id

  • user_mail

  • client_id

  • client_secret

  • refresh_token

  • access_token

  • grant_token

  • expiry_time

  • redirect_url

Create FileStore object

Custom Persistence

Users can create their own logic for storing and retrieving authentication tokens using the custom persistence technique. To use Custom Persistence, the user must implement TokenStore interface (com\zoho\api\authenticator\store\TokenStore) and override the methods.

Configuration

Before you get started with creating your PHP application, you need to register your client and authenticate the app with Zoho.

The user key will be used to store and identify the tokenstore details in the DB or File Storage for token persistence. The environment key contains the domain information to make API calls. The token key represents the OAuth info, including the clientID, clientSecret, grantToken, redirectURL, refreshToken or accessToken depending on the flow that you use. Refer to ##create an instance of OAuthToken## for more details.

• Create an instance of UserSignature that identifies the current user.

• Configure the API environment which decides the domain and the URL to make API calls.

• Create an instance of OAuthToken with the information that you get after registering your Zoho client. In the context of token persistence, the grant token flow and refresh token flow involve storing and persisting the token. However, the access token flow does not involve token persistence and the access token is directly utilized for API calls. Depending on the tokens available with you, choose grantToken flow, refreshToken flow or accessToken flow.

  • Use the following method for grantToken flow :

  • Use the following method for refreshToken flow :

  • Use the following method for accessToken flow :

• Create an instance of Logger Class to log exception and API information. By default, the SDK constructs a Logger instance with level - INFO and file_path - (sdk_logs.log, created in the current working directory)

• Create an instance of TokenStore to persist tokens, used for authenticating all the requests. By default, the SDK creates the sdk_tokens.txt in the current working directory to persist the tokens.

  • Use the following method for DB Store

  • Use the following method for File Store

  • Use the following method for Custom Store

• Create an instance of SDKConfig containing SDK configurations.

• Create an instance of RequestProxy containing the proxy properties of the user.

• The path containing the absolute directory path to store user specific files containing module fields information.

Initializing the Application

Initialize the SDK using the following code.

• You can now access the functionalities of the SDK. Refer to the sample codes to make various API calls through the SDK.

Class Hierarchy

Responses and Exceptions

All SDK method calls return an instance of the APIResponse class.

Use the getObject() method in the returned APIResponse object to obtain the response handler interface depending on the type of request (GET, POST,PUT,DELETE).

APIResponse<ResponseHandler> and APIResponse<ActionHandler> are the common wrapper objects for Zoho CRM APIs’ responses.

Whenever the API returns an error response, the response will be an instance of APIException class.

All other exceptions such as SDK anomalies and other unexpected behaviours are thrown under the SDKException class.

• For operations involving records in Tags

  • APIResponse<RecordActionHandler>

• For getting Record Count for a specific Tag operation

  • APIResponse<CountHandler>

• For operations involving BaseCurrency

  • APIResponse<BaseCurrencyActionHandler>

• For Lead convert operation

  • APIResponse<ConvertActionHandler>

• For retrieving Deleted records operation

  • APIResponse<DeletedRecordsHandler>

• For Record image download operation

  • APIResponse<DownloadHandler>

• For MassUpdate record operations

  • APIResponse<MassUpdateActionHandler>

  • APIResponse<MassUpdateResponseHandler>

• For Transfer Pipeline operation

  • APIResponse<TransferActionHandler>

GET Requests

• The getObject() of the returned APIResponse instance returns the response handler interface.

• The ResponseHandler interface encompasses the following

  • ResponseWrapper class (for application/json responses)
  • FileBodyWrapper class (for File download responses)
  • APIException class

• The CountHandler interface encompasses the following

  • CountWrapper class (for application/json responses)
  • APIException class

• The DeletedRecordsHandler interface encompasses the following

  • DeletedRecordsWrapper class (for application/json responses)
  • APIException class

• The DownloadHandler interface encompasses the following

  • FileBodyWrapper class (for File download responses)
  • APIException class
• The MassUpdateResponseHandler interface encompasses the following
  • MassUpdateResponseWrapper class (for application/json responses)
  • APIException class

POST, PUT, DELETE Requests

• The getObject() of the returned APIResponse instance returns the action handler interface.

• The ActionHandler interface encompasses the following

  • ActionWrapper class (for application/json responses)
  • APIException class

• The ActionWrapper class contains Property/Properties that may contain one/list of ActionResponse interfaces.

• The ActionResponse interface encompasses following

  • SuccessResponse class (for application/json responses)
  • APIException class

• The ActionHandler interface encompasses following

  • ActionWrapper class (for application/json responses)
  • APIException class

• The RecordActionHandler interface encompasses following

  • RecordActionWrapper class (for application/json responses)
  • APIException class

• The BaseCurrencyActionHandler interface encompasses following

  • BaseCurrencyActionWrapper class (for application/json responses)
  • APIException class

• The MassUpdateActionHandler interface encompasses following

  • MassUpdateActionWrapper class (for application/json responses)
  • APIException class

• The ConvertActionHandler interface encompasses following

  • ConvertActionWrapper class (for application/json responses)
  • APIException class
• The TransferActionHandler interface encompasses the following
  • TransferActionWrapper class (for application/json responses)
  • APIException class

Multi User and Multi DC support in the PHP SDK

In the PHP SDK, multi-user functionality is achieved using the switchUser() method. To use this method, you need to provide the user, environment, token, and SDK configuration details.

Please note that only one user can send requests at a time. If another user need to send requests, the switchUser() method must be used prior to sending the requests.

To Remove a user's configuration in SDK. Use the below code

• The program execution starts from main().

• The details of "user1" are is given in the variables user1, token1, environment1.

• Similarly, the details of another user "user2" is given in the variables user2, token2, environment2.

  • If you have enabled multi-dc support in the client app, the token object will be DC specific. In multi-DC enabled case, the client-id will be the same for different DCs for the same org, but the tokens (grant, refresh and access) will be different. The client-secret could be the same or different, depending on how you have configured it.

• Then, the switchUser() function is used to switch between the "user1" and "user2" as required.

• Based on the latest switched user, the $this->getRecords($moduleAPIName) will fetch record.

SDK Sample code