Python SDK - 概要

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

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

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

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

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

環境設定

Python SDKは「pip」を使用してインストールできます。pipはPythonの依存関係管理用のツールです。SDKのクライアントアプリに関する要件は次のとおりです。

  • クライアントアプリにはPython 2.7以上が必要です。
    • https://www.python.org/downloads/
  • クライアントアプリにはpython requestsがインストールされている必要があります。
    • http://docs.python-requests.org/en/master/user/install/
  • Python SDKはpipを使用してインストールする必要があります。
  • アプリケーションの起動時に、メソッドZCRMRestClient.initialize()を呼び出す必要があります。
  • MySQLは、デフォルトポート3306で機能する同じマシンで実行する必要があります。
    • データベース名は"zohooauth"にする必要があります。
    • 「user identifier」（varchar(100)）、「accesstoken」（varchar(100)）、「refreshtoken」（varchar(100)）、「expirytime」（bigint）の列を含むテーブル「oauthtokens」が必要です。