既存のAPIユーザーのお客さまへ

開発者APIフォーラムでCRM認証トークンについてご確認ください。

お客さまが開発者APIの既存ユーザーで、すべてのAPI呼び出しでAPIチケットとAPIキーをお使いの場合、URLをCRM認証トークンに置き換えることをお勧めします。認証トークンの詳細については、こちらをクリックしてください。

注：

  • APIキーとAPI問い合わせのサポートは、2012年6月30日で終了します。

1. 認証トークンの使用には、どのような利点がありますか。

API問い合わせと異なり、認証トークンは永続的であるため、新しいトークンを7日ごとに作成する必要がありません。

2. APIキーと問い合わせを認証トークンに置き換えるにはどうすればよいですか。

認証トークンの作成形式は、次のとおりです。

https://accounts.zoho.com/apiauthtoken/nb/create?SCOPE=ZohoCRM/crmapi&EMAIL_ID=Zoho CRM Username or Email ID&PASSWORD=Your Zoho CRM Password

たとえば、［見込み客］タブから全見込み客を取得するAPI呼び出しは次のようになります。

https://crm.zoho.com/crm/private/xml/Leads/getCVRecords?newFormat=1&authtoken=7d987676893g4j09h43dd0b167dda34b&scope=crmapi&cvName=All Open Leads

 API制限

Zoho CRMプランAPIリクエスト数 - 上限
無料プラン
（3ユーザー無料）		合計250リクエスト/日/組織
プロフェッショナルプラン
（12 USD/ユーザー/月）		250リクエスト/日/ユーザーライセンス、または
5,000リクエスト/日/組織のいずれか少ない方
エンタープライズプラン
（25 USD/ユーザー/月）

250リクエスト/日/ユーザーライセンス、または
15,000リクエスト/日/組織のいずれか少ない方

たとえば、無料プランでgetRecordsメソッドを使用すると、1リクエストあたり最大200データを取得できるため、1日あたり合計50,000データ（250 x 200 = 50,000データ）を取得できます。

重要：getSearchRecordsまたはgetCVRecordsメソッドを使用する場合、ご利用のZoho CRMプランに関係なく、1日あたり最大250リクエストを送信できます。

 APIキーを作成するには（APIの既存ユーザーのみ）

  1. 管理者権限でZoho CRMにサインインしてください。
  2. ［設定］>［開発者用情報］>［API］>［CRM APIキー］の順に移動してください。
  3. 以下のようなセクションが表示されます。
    引き続き認証にCRM APIキーを使用する場合は、ここをクリックしてください。
  4. リンクをクリックすると、APIキーが表示されます。

 チケットを作成するには（APIの既存ユーザーのみ）

APIリクエストを開始する際、チケットパラメーター（暗号化された英数字文字列）を渡して、Zohoでユーザー認証情報を認証する必要があります。特定のユーザーの問い合わせを作成するには、認証されたHTTPS POSTリクエストを、セキュリティ保護された接続を介してZohoアカウントへ送信する必要があります。

サポートされているパラメーターを使用したPOST形式のフォーム例：

<form method=" POST " action=" https://accounts.zoho.com/login" target="_self">
<input type="hidden" name=" LOGIN_ID " value="[ZOHO Username or Email ID]">
<input type="hidden" name=" PASSWORD " value="[Password for ZOHO ID]">
<input type="hidden" name=" FROM_AGENT " value="true">
<input type="hidden" name=" servicename " value="ZohoCRM">
<input type="submit" value="Generate Ticket" class="divbutton" name="submit">
</form>

URLで渡される必須パラメーターとその値は以下のとおりです。

パラメーター型説明
servicenameZohoCRMサービス名にはZohoCRMを指定してください。
FROM_AGENT真偽値True
LOGIN_ID文字列ユーザーのZoho IDまたはメールアドレスです。
PASSWORD文字列Zoho IDのパスワードです。

リクエストされたURLに渡すパラメーターに応じて、以下の形式のレスポンスが返されます。

パラメーター型説明
コメント文字列チケットの作成日時です。
GETUSERNAME  
WARNING文字列URLで渡されたパラメーターが正しくない場合、そのことを伝える警告メッセージが返されます。それ以外の場合、値はnullになります。
PASS_EXPIRY整数パスワードの有効期限を表示してください。Zohoアカウントにパスワードの有効期限が設定されていない場合は、-1の値が返されます。
TICKET文字列リクエストに作成されたチケットです（32文字）。
RESULT真偽値チケットが正常に作成された場合は値がTRUEに、そうでない場合はFALSEになります。

例1：チケット作成成功パターン

# #Thu Apr 01 20:29:06 PDT 2010
GETUSERNAME=null
WARNING=null
PASS_EXPIRY=-1
TICKET=5767ef44382712202e432d57da576b34
RESULT=TRUE

例2：チケット作成失敗パターン

# #Thu Apr 01 20:34:34 PDT 2010
CAUSE=Username and Password do not match
RESULT=FALSE

重要事項：

  • APIチケットの有効期間は7日間です。7日間経過した後にZoho CRM - APIサービスを使用するには、新たにチケットを作成する必要があります。新しいチケットIDでアプリケーションを更新しないと、APIリクエストから「4834 - Invalid Ticket ID」というエラーレスポンスが返されます。
  • APIリクエストごとにAPIチケットを作成しないことを強くお勧めします。7日間は問題なく、アプリケーションで同じチケットを使用できます。
  • 使用できる有効なセッション数は最大20です。

注：

  • チケットが作成されるたびにセッションが作成されます。このセッションは7日間有効です。

有効なセッション数が20を超えると、次のようなレスポンスが返されます。

CAUSE=Maximum Concurrent User Tickets Limit ExceededRESULT=FALSE
API同時セッション数の上限を超えないようにするには、以下のいずれかの方法に従います。
APIチケットの再利用：一度作成したAPIチケットは、7日間使用できます。チケットの新規作成が必要となるのは、7日間が経過した後のみです。
サインアウト：操作が完了したら、チケットをクリア/サインアウトしてください。

APIチケットをクリア/サインアウトするHTTPS POSTリクエストは、次のようになります。

<form method="POST" action="https://accounts.zoho.com/logout" target="_self">
<input type="hidden" name="ticket" value="<ticket_value>">
<input type="hidden" name="FROM_AGENT" value="true">
</form>

セッションを閉じる：https://accounts.zoho.com/にアクセスし、［有効なセッション］ > ［他のセッションをすべて閉じる］の順にクリックしてください。

 テストプログラム

APIチケットが無効になった後、再作成するプログラム例は次のとおりです。

プログラム