Multi-User and Multi-DC Support

Multi-users functionality is achieved using 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.

Copy to Clipboard
  (new InitializeBuilder())
  ->user($user)
  ->environment($environment)
  ->token($token)
  ->SDKConfig($configInstance)
  ->switchUser();

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

Copy to Clipboard
  Initializer::removeUserConfiguration($user, $environment);

Copy to Clipboard
<?php
use com\zoho\api\authenticator\OAuthBuilder;
use com\zoho\crm\api\InitializeBuilder;
use com\zoho\crm\api\UserSignature;
use com\zoho\crm\api\dc\USDataCenter;
use com\zoho\crm\api\dc\EUDataCenter;
use com\zoho\crm\api\Initializer;
use com\zoho\crm\api\record\RecordOperations;
use com\zoho\crm\api\record\GetRecordsHeader;
use com\zoho\crm\api\HeaderMap;
use com\zoho\crm\api\ParameterMap;
require_once 'vendor/autoload.php';

class MultiUser
{
  public function main()
  {
    $environment1 = USDataCenter::PRODUCTION();
    $user1 = new UserSignature("abc1@zoho.com");
    $token1 = (new OAuthBuilder())
    ->clientId("clientId")
    ->clientSecret("clientSecret")
    ->grantToken("grantToken")
    ->redirectURL("redirectURL")
    ->build();
    (new InitializeBuilder())
    ->user($user1)
    ->environment($environment1)
    ->token($token1)
    ->initialize();
    $this->getRecords("Leads");

    $environment2 = EUDataCenter::PRODUCTION();
    $user2 = new UserSignature("abc2@zoho.eu");
    $token2 = (new OAuthBuilder())
    ->clientId("clientId2")
    ->clientSecret("clientSecret2")
    ->refreshToken("refreshToken2")
    ->redirectURL("redirectURL2")
    ->build();
    // Initializer::removeUserConfiguration($user1, $environment1);

    (new InitializeBuilder())
    ->user($user2)
    ->environment($environment2)
    ->token($token2)
    ->switchUser();
    $this->getRecords("Contacts");
  }

  public function getRecords($moduleAPIName)
  {
    try
    {
      $recordOperations = new RecordOperations();
      $paramInstance = new ParameterMap();
      $paramInstance->add(GetRecordsParam::approved(), "false");
      $headerInstance = new HeaderMap();
      $ifmodifiedsince = date_create("2020-06-02T11:03:06+05:30")->setTimezone(new \DateTimeZone(date_default_timezone_get()));
      $headerInstance->add(GetRecordsHeader::IfModifiedSince(), $ifmodifiedsince);
      $response = $recordOperations->getRecords($moduleAPIName,$paramInstance, $headerInstance);
      echo($response->getStatusCode() . "\n");
      print_r($response->getObject());
      echo("\n");
    }
    catch (\Exception $e)
    {
      print_r($e);
    }
  }
}
$obj = new MultiUser();
$obj->main();
?>

1. The program execution starts from main().

2. The details of user1 are given in the variables user1, token1, environment1.

3. Similarly, the details of another user user2 are given in the variables user2, token2, environment2.

   Note: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.

4. Then, the Switch user function is used to switch between the User1 and User2 as required.

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

SDK Sample Code

Copy to Clipboard
<?php
use com\zoho\api\authenticator\OAuthBuilder;
use com\zoho\crm\api\InitializeBuilder;
use com\zoho\crm\api\UserSignature;
use com\zoho\crm\api\dc\USDataCenter;
use com\zoho\crm\api\record\RecordOperations;
use com\zoho\crm\api\HeaderMap;
use com\zoho\crm\api\ParameterMap;
use com\zoho\crm\api\record\GetRecordsHeader;
use com\zoho\crm\api\record\GetRecordsParam;
use com\zoho\crm\api\record\ResponseWrapper;
require_once 'vendor/autoload.php';

class Record
{
  public function initialize()
  {
    $user = new UserSignature("abc@zoho.com");
    $environment = USDataCenter::PRODUCTION();
    $token = (new OAuthBuilder())
    ->clientId("clientId")
    ->clientSecret("clientSecret")
    ->refreshToken("refreshToken")
    ->redirectURL("redirectURL")
    ->build();
    (new InitializeBuilder())
    ->user($user)
    ->environment($environment)
    ->token($token)
    ->initialize();
  }

  public function getRecord()
  {
    try
    {
      $recordOperations = new RecordOperations();
      $paramInstance = new ParameterMap();
      $paramInstance->add(GetRecordsParam::approved(), "both");
      $headerInstance = new HeaderMap();
      $ifmodifiedsince = date_create("2020-06-02T11:03:06+05:30")->setTimezone(new \DateTimeZone(date_default_timezone_get()));
      $headerInstance->add(GetRecordsHeader::IfModifiedSince(), $ifmodifiedsince);
      $moduleAPIName = "Leads";
      $response = $recordOperations->getRecords($moduleAPIName, $paramInstance, $headerInstance);
      if($response != null)
      {
        echo("Status Code: " . $response->getStatusCode() . "\n");
        $responseHandler = $response->getObject();
        if($responseHandler instanceof ResponseWrapper)
        {
          $responseWrapper = $responseHandler;
          $records = $responseWrapper->getData();
          if($records != null)
          {
            $recordClass = 'com\zoho\crm\api\record\Record';
            foreach($records as $record)
            {
              echo("Record ID: " . $record->getId() . "\n");
              $createdBy = $record->getCreatedBy();
              if($createdBy != null)
              {
                echo("Record Created By User-ID: " . $createdBy->getId() . "\n");
                echo("Record Created By User-Name: " . $createdBy->getName() . "\n");
                echo("Record Created By User-Email: " . $createdBy->getEmail() . "\n");
              }
              echo("Record CreatedTime: ");
              print_r($record->getCreatedTime());
              echo("\n");
              $modifiedBy = $record->getModifiedBy();
              if($modifiedBy != null)
              {
                echo("Record Modified By User-ID: " . $modifiedBy->getId() . "\n");
                echo("Record Modified By User-Name: " . $modifiedBy->getName() . "\n");
                echo("Record Modified By User-Email: " . $modifiedBy->getEmail() . "\n");
              }
              echo("Record ModifiedTime: ");
              print_r($record->getModifiedTime());
              print_r("\n");
              $tags = $record->getTag();
              if($tags != null)
              {
                foreach($tags as $tag)
                {
                  echo("Record Tag Name: " . $tag->getName() . "\n");
                  echo("Record Tag ID: " . $tag->getId() . "\n");
                }
              }
              echo("Record Field Value: " . $record->getKeyValue("Last_Name") . "\n");
              echo("Record KeyValues : \n" );
              foreach($record->getKeyValues() as $keyName =--> $value)
              {
                echo("Field APIName" . $keyName . " \tValue : ");

                print_r($value);

                echo("\n");
              }
            }
          }
        }
      }
    }
    catch (\Exception $e)
    {
      print_r($e);
    }
  }
}

$obj = new Record();
$obj->initialize();
$obj->getRecord();
?>

Record Response