Zoho CRM用PHP SDK - 概要

PHP SDKを使用すると、Zoho CRMと連携できるクライアントPHPアプリケーションを作成できます。このSDKにより、必要なCRM APIにかんたんにアクセスして使用できます。つまり、このSDKはREST APIのラッパーとして機能し、Zoho CRMのサービスを利用しやすくします。

クライアントアプリケーションの開発者は、設定関連のプロパティーファイル、インターフェイスの実装、インスタンス、またはオブジェクトと共にプログラミングコードを作成する必要があることにご注意ください。Zoho CRM APIにアクセスするための認証は、OAuth認証メカニズムによって行われます。常に、HTTPリクエストとレスポンスがSDKによって処理されます。

Zoho CRMとクライアントPHPアプリケーションの間のミドルウェアまたはインターフェイスとして、SDKがどのように機能するかを示す例です。

PHP SDKでは次のことが可能です。

  1. Zoho CRMとCRMエンティティーがクラスとしてモデル化されているクライアントアプリケーションとの間でデータをやりとりできます。
  2. CRM APIの同等のものは、PHPアプリケーションのシンプルな関数として宣言、定義されます。
  3. CRMサービスの適切なAPIにアクセスして、Zoho CRMにデータを送信できます。

環境設定

PHP SDKはcomposerを介してインストールできます。composerはPHPの依存関係管理用のツールです。SDKで必要なクライアントアプリの条件は次のとおりです。

  • curl拡張機能を有効にしたPHP 5.6以上がクライアントアプリに必要です。
  • PHP SDKは、composerを介してクライアントアプリにインストールする必要があります。
  • アプリの起動時に関数ZCRMRestClient::initialize()を呼び出す必要があります。
  • MySQLは、デフォルトポート3306で機能する同じマシンで実行する必要があります。
  • データベース名はzohooauthにする必要があります。
  • useridentifier（varchar(100)）、accesstoken（varchar(100)）、refreshtoken（varchar(100)）、expirytime（bigint）の列を含むテーブルoauthtokensが必要です。

注：

  • token_persistence_pathがosauth_configuration.propertiesファイルに指定されている場合、永続性はファイル内でのみ発生します。この場合、MySQLは必要ありません。上記のtoken_persistence_pathで、名前がzcrm_oauthtokens.txtの空のファイルを作成してください。

SDKの使用

PHP SDKを使用するクライアントアプリのPHPファイルに、以下の行を追加してください。

require ‘vendor/autoload.php’

この行を通じて、PHP SDKのすべての機能にアクセスできます。