Zoho CRM APIのバージョン1.0は、2018年12月31日に提供を終了しました。機能が向上した、新しいAPI バージョン2.0をお試しください。
認証トークンの使用
Zoho CRM API は、Zoho CRMの全プランで使用できます。APIを使用するには、CRMアカウントのZoho CRM認証トークンが必要です。APIサービスへのアクセス権限があることを確認してください。権限がない場合は、CRM管理者にお問い合わせください。
認証トークンの生成
認証トークンを生成するには、下記のURL形式を使用して、認証リクエストをZoho Accountsに送信する必要があります。ご自分が認証済みユーザーであることを確かめてください。認証済みユーザーでない場合、認証トークンの生成中に「ACCOUNT_REGISTRATION_NOT_CONFIED」エラーが発生することがあります。
URL形式
APIモード:
APIモードで認証トークンを生成するには、次の操作を行ってください。
- Zoho CRMにサインインしてください。
- https://accounts.zoho.comを開いてください。
- Zoho Accountsのホームページで、[2段階認証]をクリックしてください。
- [2段階認証]ページで、[アプリケーション専用のパスワードの管理]をクリックしてください。
- [アプリケーション専用のパスワード]ポップアップで、次の操作を行ってください。
- デバイス名またはアプリケーション名を入力してください。
- 現在のパスワードを入力してください。
- [作成]をクリックしてください。スペースを含む、新しいアプリケーション固有のパスワードが送信されます。
- 認証トークンを生成するには、パスワードのスペースを削除し、次のAPIモードURLを含めます。
https://accounts.zoho.com/apiauthtoken/nb/create?SCOPE=ZohoCRM/crmapi&EMAIL_ID=[Username/EmailID]&PASSWORD=[Password]&DISPLAY_NAME=[ApplicationName]
注:
- HTTP POSTメソッドを使用して、リクエストを作成してください。
このURLとともに渡されるパラメーターは、以下のとおりです。
パラメーター | 詳細 |
EMAIL_ID | Zoho CRMのユーザー名、またはメールIDを指定してください。 |
scope | 値を「ZohoCRM/crmapi」と指定してください。 |
PASSWORD | Zoho CRMのパスワードを指定してください。 |
DISPLAY_NAME | この認証トークンの用途を示すアプリケーション名を指定してください。例:「MailChimp」や「Google Workspace」(旧:Google Workspace) |
詳細については、2段階認証のヘルプページを参照してください。
レスポンス例
#
#Wed Feb 29 03:07:33 PST 2012
AUTHTOKEN=bad18eba1ff45jk7858b8ae88a77fa30
RESULT=TRUE
注:
- 認証トークンは、すべてのAPI呼び出しで使用できます。URL形式は、[設定] > [開発者向け情報] > [API]でも確認できます。
- ブラウザーモードを使用するには、CRMアカウントにサインインする必要があります。
例
データを取得する例を、以下に示します。
https://crm.zoho.com/crm/private/xml/Leads/getRecords?authtoken=7d987658943g4j09h43dd0b167dda34b&scope=crmapi
認証トークンの取り消し
アカウント用に生成された認証トークンは、[Zohoアカウント]ページから削除できます。
- Zoho CRMにサインインしてください。
- [ユーザー名] > [マイ・アカウント]の順に開いてください。
- [取引先]ページで、[有効な認証トークン]をクリックしてください。
- [有効な認証トークン]ページで、認証トークンを[削除](取り消し)できます。
注:
- セキュリティー上の理由から、既存の認証トークンを表示することはできません。認証トークンが生成されたら、保存してください。
- 認証トークンを取り消すと、そのトークンは完全に削除されます。
- 認証トークンを再生成する場合は、新しいトークンでプログラムを更新してください。
留意点
- 認証トークンは、ユーザー固有の永続的なトークンです。
- 削除すると、既存のトークンは完全に削除されます。すべてのAPI呼び出しで、新しいトークンに置き換える必要があります。
- ユーザーが無効にされると、ユーザーのアカウントの認証トークンは無効になります。
- 組織がAPI制限を超えた場合は、CRMユーザー(認証トークンを生成したユーザー)に通知されます。
- アプリケーションで上限を超える呼び出しが必要でも、追加のAPIリクエストは処理されません。データ転送の問題を回避するには、API要件を事前に評価してください。サポートが必要な場合は、Zohoのサポート窓口(support@zohocrm.com)までお問い合わせください(英語対応)。