Zoho CRMのREST APIを使用してリード情報を取得する

こんにちは。香田です。

今回はZoho CRMのREST APIを使用してリード情報を取得する方法を紹介していきます。

流れとしては認証用のトークンを発行し、curlコマンドを使用しリード情報を取得する流れとなります。

Zoho API Consoleへアプリケーションの登録

Zoho CRMのREST APIを使用する場合、はじめにZoho API Consoleへアプリケーションを登録する必要があります。

今回、curlコマンドを利用しリード情報を取得するサンプルの為、Self Clientを選択していきます。

Zoho API Consoleへアクセスし、[Client Type]に[Self Client]を選択し[CREATE]をクリックします。

[Generate Code]より[Scope]、[TIme Duration]、[Scope Description]を適宜入力し[CREATE]をクリックします。

今回はリード情報取得する為、[Scope]はZohoCRM.modules.ALLを設定しています。

利用可能なScopeに関してはこちらを参考にしてみてください。

Portal選択で対象の組織を選択し、[CREATE]をクリックします。認可コードが発行されるのでコピーします。

同様にClient ID、Client Secretもコピーします。

Zoho CRM アクセストークンの発行

次にアクセストークンを発行します。コピーしたClient ID、Client Secret、認可コードを利用していきます。

また、grant_typeにはauthorization_codeを設定し、redirect_uriはダミーのURIを設定してください。

$ curl -X POST https://accounts.zoho.com/oauth/v2/token \
-F "grant_type=authorization_code" \
-F "client_id=xxxx" \
-F "client_secret=xxxx" \
-F "redirect_uri=https://example.com" \
-F "code=xxxx"

実行すると下記のように1時間のみ使用可能なアクセストークンと、有効期限が設定されていないリフレッシュトークンが発行されます。

{
  "access_token": "xxxx",
  "refresh_token": "xxxx",
  "api_domain": "https://www.zohoapis.com",
  "token_type": "Bearer",
  "expires_in": 3600
}

補足として、アクセストークンの期限が切れた際はリフレッシュトークンを下記のように設定し実行することで再発行可能となります。

grant_typeはrefresh_tokenを設定してください。

$ curl -X POST https://accounts.zoho.com/oauth/v2/token \
-F "grant_type=refresh_token" \
-F "client_id=xxxx" \
-F "client_secret=xxxx" \
-F "refresh_token=xxxx"

Zoho CRM REST APIでリード情報の取得

発行されたアクセストークンを利用しリード情報を取得します。

$ curl -X GET "https://www.zohoapis.com/crm/v2/Leads" \
-H "Authorization: Zoho-oauthtoken xxxx"

実行すると下記のようなデータが確認できるはずです。

{
  "data": [
    {
      "Owner": {
        "name": "test",
        "id": "4640516000000291001",
        "email": "test@example.com"
      },
      "Company": "デモ株式会社",
      "Email": "test@example.com",
      "$currency_symbol": "￥",
      "Last_Activity_Time": null,
      "Industry": "中小企業",

      ~ 略 ~

  ],
  "info": {
    "per_page": 200,
    "count": 9,
    "page": 1,
    "more_records": false
  }
}

さいごに

Zoho CRMのREST APIを使用してリード情報を取得する方法いかがでしたでしょうか。

今回利用したREST APIには、他にもアカウントやコンタクトなど様々なモジュールがサポートされています。

こちらのドキュメントに記載されていますので参考にしてみてください。

最後までご覧頂きありがとうございます。