【ZOHO CRM API】COQL Queryを使って情報を取得する方法

はじめに

こんにちは。前回に引き続き今回もZOHO CRM APIの使い方について書きます。ZOHO CRMは非常に使いやすいツールですが、APIの日本語文献が少なくいつも困っている方も多いと思います。そこで今回は、ZOHO CRM APIで情報を取得する方法を紹介します。

アクセストークンの発行

ZOHO CRM APIを使うには、まずアクセストークンを発行する必要があります。アクセストークンとは、APIを呼び出す際に必要な認証情報のことです。アクセストークンの発行方法は前回書いた

の記事を参考にしてください。

COQL Queryを使って顧客情報を取得する

ZOHO CRM APIで情報を取得する方法はいくつかありますが、今回はCOQL Queryという機能を使ってみましょう。COQL Queryとは、ZOHO CRMのデータベースに対してSQL風のクエリを実行できる機能です。COQL Queryを使うと、以下のようなメリットがあります。

• 情報が追加あるいは更新直後でも問題なく情報を見ることができる
• 複雑な条件やソートなども簡単に指定できる
• レスポンスがJSON形式で返ってくるので、データの加工や表示がしやすい

COQL Queryを使うには、以下のURLにPOSTリクエストを送ります。例えば、姓が「山田」で名が「太郎」の顧客情報（ID, 姓, 名）を取得したい場合は、以下のようなリクエストを送ります。

curl "https://www.zohoapis.com/crm/v4/coql" ^
-H "Authorization: Zoho-oauthtoken [access_token]" ^
-d "{ \"select_query\" : \"select id, Last_Name, First_Name from Contacts where ((Last_Name = '山田') AND (First_Name = '太郎'))\"}" ^
-X POST

返り値は以下の通りです。

{"data":[{"First_Name":"太郎","Last_Name":"山田","id":"XXXXXXXXXXXXXXXXXXXX"}],"info":{"count":1,"more_records":false}}

ここで、Contactsという単語は、ZOHO CRM の設定画面の「API」をクリックして、「API名」をクリックすると表示されるモジュール名です。下記のスクリーンショット を参照してください。他のモジュールを指定したい場合にご参考ください。

また、Last_NameやFirst_Nameという単語は、同じ画面でカラム名をクリックすると表示されるフィールド名です。下記のスクリーンショット を参照してください。他のフィールド名を指定したい場合にご参考ください。

このようにして、任意のモジュールやフィールド名を指定して、情報を取得することができます。

例えば、メールアドレスから取得したい場合は、以下のようなリクエストを送ります。

curl "https://www.zohoapis.com/crm/v4/coql" ^
-H "Authorization: Zoho-oauthtoken [access_token]" ^
-d "{ \"select_query\" : \"select id, Last_Name, First_Name from Contacts where ((Email = 'abcd@example.com'))\"}" ^
-X POST

まとめ

今回は、ZOHO CRM APIで顧客情報を取得する方法を紹介しました。COQL Queryを使うと、簡単にデータを取得できるだけでなく、リアルタイムに反映されるので、最新の情報を確認できます。ZOHO CRM APIは他にも様々な機能がありますので、ぜひ試してみてください。次回は、ZOHO CRM APIで顧客情報を追加と更新する方法を紹介します。お楽しみに！

参考文献

Get Records through COQL Query | Online Help – Zoho CRM