リリースノート

APIの最小利用制限の拡大

すべてのプランでAPIの最小上限を拡大し、APIの使用環境を改善しました。

Zoho CRMプランAPIリクエスト数 - 上限
無料プラン1,000リクエスト/日/組織
スタンダードプラン
  • 最小 - 2,000リクエスト/日/組織
  • 最大 - 5,000リクエスト/日/組織、または
    250リクエスト/ユーザーライセンスのいずれか少ない方
プロフェッショナルプラン
  • 最小 - 3,000リクエスト/日
  • 最大 - 10,000リクエスト/日/組織、または
    250リクエスト/ユーザーライセンスのいずれか少ない方
エンタープライズプラン
  • 最小 - 4,000リクエスト/日
  • 最大 - 25,000リクエスト/日/組織、または
    500リクエスト/ユーザーライセンスのいずれか少ない方

この変更の詳細については、APIの制限を参照してください。

リリース日：2014年11月1日

新規メソッド：searchRecords

タブからデータを検索できるように、searchRecordsメソッドを導入しました。この新規メソッドの詳細については、APIガイドを参照してください。

リリース日：2014年10月20日

新規メソッド：getModulesとgetDeletedRecordIds

CRMタブリストとごみ箱にある削除済みデータのIDリストを取得できるように、以下のメソッドを導入しました。

これらの新規メソッドの詳細については、APIガイドを参照してください。

リリース日：2014年8月7日

APIリクエスト数

Zoho CRM API は、Zoho CRMの全プランで使用できます。APIを使用するには、CRMアカウントのZoho CRM認証トークンが必要です。APIサービスにアクセスする権限があることを確認してください。権限がない場合は、CRM管理者にお問い合わせください。

API制限

Zoho CRMプランAPIリクエスト数 - 上限
無料プラン250リクエスト/日/組織
スタンダードプラン最小 - 1,000リクエスト/日

最大 - 5,000リクエスト/日/組織、または
250リクエスト/ユーザーライセンスのいずれか少ない方
プロフェッショナルプラン最小 - 2,000リクエスト/日

最大 - 10,000リクエスト/日/組織、または
250リクエスト/ユーザーライセンスのいずれか少ない方
エンタープライズプラン最小 - 3,000リクエスト/日

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

重要事項：

  • たとえば、無料プランでgetRecordsメソッドを使用すると、1リクエストあたり最大200データを取得できるため、1日あたり合計50,000データ（250 x 200 = 50,000データ）を取得できます。
  • getSearchRecordsまたはgetCVRecordsメソッドを使用する場合、ご利用のZoho CRMプランに関係なく、1日あたり最大250呼び出しを送信できます。

リリース日：2013年6月15日

新規メソッド：開発者APIを使用した、データへのファイルまたは写真の添付

ファイルや写真をデータに添付できるように、以下のメソッドを導入しました。

  • uploadFile
  • downloadFile
  • deleteFile
  • uploadPhoto
  • downloadPhoto
  • deletePhoto

開発者APIフォーラムでは、発表内容をすべて確認できます。
これらの新規メソッドの詳細については、APIガイドを参照してください。

リリース日：2012年7月11日

認証トークンの導入

開発者APIの実装において、認証トークンがサポート対象になりました。

このトークンは永続的なトークンです。削除を選択した場合にのみ無効になります。

認証トークンの詳細については、APIガイドを参照してください。

リリース日：2012年3月5日

新規メソッドの導入

開発者APIに以下のメソッドを導入しました。

  • getFields
  • getRelatedRecords
  • updateRelatedRecords
APIメソッド目的
getFields

特定のタブで使用できる項目の詳細をすべて取得します。

getRelatedRecords

別のデータ（主要データ）に関連するデータを取得します。。

updateRelatedRecords

別のデータに関連付けられているデータを更新します。

開発者APIフォーラムでは、発表内容をすべて確認できます。これらの新規メソッドの詳細については、APIガイドを参照してください。

リリース日：2012年1月27日

2011年4月28日以降はHTTPSのみをサポート：

現時点では、HTTPとHTTPSの両方をサポートしながら開発者APIを実装しています。4週間後、すべてのAPIトランザクションをHTTPS経由でのみサポートし、HTTPプロトコルを完全に廃止する予定です。この追加のSSL、256ビットセキュリティシステムによって、データ転送時のセキュリティの問題から外部サービス連携を保護できます。

2011年4月28日以降、プログラムでHTTPを使用し続けた場合、APIリクエストは実行されません。そのため、開発者コミュニティの皆さまには、できるだけ早くHTTPSリクエストを使ってZoho CRM APIを呼び出すようにすることを強くお勧めします。

新規パラメーター「version」の導入

開発者APIメソッドに、versionという新しいパラメーターを導入しました。このパラメーターを使用すると、「キャンペーンのデータ元」項目の値を取得できます。
［キャンペーン］タブの最近の強化では、キャンペーンメンバー機能をサポートするためにキャンペーンのデータ元項目が削除されました。この強化の内容は次のとおりです。

  • 複数の見込み客と連絡先をキャンペーンに関連付けることができるようになりました。
  • 複数の見込み客/連絡先を1件ずつ関連付けるのではなく、インポートすることで時間を節約できるようになりました。
  • キャンペーンのデータ元項目は、［見込み客］タブと［連絡先］タブで使用できなくなりました。

この強化の詳細については、移行ガイドをご覧ください。

APIリクエストにおけるversionパラメーターの使い方

メソッドのversionパラメーターを使用すると、API実装でキャンペーンのデータ元項目の値を取得できます。
値が「1」の「version」パラメーターは、キャンペーンのデータ元項目からもレスポンスを取得します。
値が「2」の「version」パラメーターは、現在のAPI実装に基づいてレスポンスを取得します。この場合、「キャンペーンのデータ元」項目の値は取得されません。

これは必須パラメーターではありません。2011年10月30日までは、すべてのレスポンスが強化前の実装に基づいて取得されます。この期間中に新しい実装に基づいてレスポンスを取得する場合は、リクエスト内で値が「2」のversionパラメーター（version=2）を使用してください。

注：

  • これは必須パラメーターではありません。
  • 2011年10月30日までは、すべてのレスポンスが強化前の実装に基づいて取得されます。この期間中に新しい実装に基づいてレスポンスを取得する場合は、リクエスト内で値が「2」のversionパラメーター（version=2）を使用してください。
  • 2011年10月30日以降は、version 1のサポートは終了し、version 2のみがサポートされます。

「version」パラメーターの使い方の例はこちらです。
また、getRelatedRecordsという新しいAPIメソッドも導入しました。別のタブにあるデータに関連するデータ（見込み客や連絡先など）を取得できます。
たとえば、特定のキャンペーンに関連付けられている見込み客や連絡先を取得できます。詳細はこちら

リリース日：2011年4月17日

Zoho CRM開発者APIとその他の変更点のGAリリース

Zohoは、Zoho CRMサービス用APIのGAリリースを発表します。ZohoのAPIはXML形式とJSON形式で利用可能で、開発者コミュニティは好みのプログラミング言語を使用してアプリケーションを構築できます。リアルタイム導入ニーズに対応できるよう、堅牢でより優れたAPIメソッドを用意しました。バグの特定、新しい利用例やサンプルの公開など、お客さまのご協力のおかげで、CRMシステム用APIを改善できました。GAリリースに加え、既存のAPI実装も大幅に変更されています。このため、開発者コミュニティの将来のニーズにも対応できます。これらの変更には、検索メソッドの廃止、新しいレスポンス形式、APIリクエストの制限、CRMビジネスロジックを追加実装する新しいAPIメソッドなどがあります。Zohoは、これらの変更により、開発者コミュニティの開発環境が改善され、Zoho CRM開発者プラットフォームが次のレベルに進化するものと確信しています。

重要な変更点

  • 既存の検索メソッドgetAllSearchRecordsとgetMySearchRecordsの廃止
  • 全メソッドに対する新しいレスポンス形式の実装
  • Zoho CRMプランに基づくAPIリクエストの制限
  • 検索、見込み客の返還削除機能への新しいメソッドの導入

APIの廃止

今後のコミュニティの成長、より優れた開発者サービスの提供、高いパフォーマンスを必要とする運用の最適化を考慮し、次のAPIメソッドを段階的に廃止します。

  • getAllSearchRecords
  • getMySearchRecords
APIメソッド目的
getAllSearchRecords担当者に関係なく、指定した検索語に関する全データを取得するために使用します。
getMySearchRecordsリクエストで指定した検索語に関して、サインイン名が担当者となっているデータを取得するために使用します。
getAllRecords名称がgetRecordsに変更されました。
getEntityRecord名称がgetRecordByIdに変更されました。

最近、getAllSearchRecordsとgetMySearchRecordsの実装中にリソースの使用量が予想より多くなっています。このような状況を解決するため、同様の機能を持つ新しい検索メソッドgetSearchRecordsとgetSearchRecordsByPDCを導入しました。これらの新しいメソッドを最適化し、パフォーマンスを向上させました。

サポート終了日：2010年1月21日

注：

  • 2010年1月21日（12:00 AM PST）より、これらのメソッドは機能しなくなります。引き続き使用すると、アプリケーションで次のエラーメッセージがスローされます。
    <response> Unable to process your request.Please verify whether you have entered proper method name, parameter and parameter values
    </response>

重要：

サポート終了前に、アプリケーションを更新して新しい検索メソッド（getSearchRecordsまたはgetSearchRecordsByPDC）を使用することを強くお勧めします。ご不明な点がありましたら、support@zohoccrm.comまでお問い合わせください（英語対応）。

廃止されたメソッドの詳細については、APIガイドを参照してください。

新しいレスポンス形式

現在、APIレスポンスのXML形式は< fieldlabel value = "LEADID" > 項目値 </ fieldlabel>となっており、開始タグと終了タグには約26文字（スペースを含む）が使われています。新しい実装では、XMLタグを<FL val="LEADID">項目値</FL>（合計8文字）に変更することでタグのサイズを短縮し、項目ごとのバイト数を約18バイト節約しています。これで、帯域幅の使用率を大幅に最適化できます。
2010年1月21日まで、レスポンスはデフォルトで以前の形式で返されます。新しい形式でレスポンスを取得する場合、APIリクエストで追加引数newFormat=1または2を渡して、Zoho CRMからデータを取得する必要があります。

重要：

データを挿入または更新するには、newFormat=1パラメーターのXMLデータを使用する必要があります。

パラメーター目的
newFormat=1値が「null」の項目を除外して、CRMアカウントのデータを取得します。
newFormat=2値が「null」の項目を含めて、CRMアカウントのデータを取得します。

古い形式：

<response uri="/crm/private/xml/Leads/getAllRecords">
<result>
<Leads>
<row no="1"> <fieldlabel value="LEADID">1111111111<fieldlabel>
<fieldlabel value="SMOWNERID">222222222</fieldlabel>
<fieldlabel value="Lead Owner">soori</fieldlabel>
<fieldlabel value="Company">NiveSoft</fieldlabel>
<fieldlabel value="First Name">Mutha</fieldlabel>
<fieldlabel value="Last Name">Raja</fieldlabel>
<fieldlabel value="Designation">null</fieldlabel>
<fieldlabel value="Email">null</fieldlabel>
<fieldlabel value="Phone">3434343</fieldlabel>
<fieldlabel value="Fax">null</fieldlabel>
<fieldlabel value="Mobile">null</fieldlabel>
<fieldlabel value="Website">null</fieldlabel>
<fieldlabel value="Lead Source">null</fieldlabel>
<fieldlabel value="Lead Status">null</fieldlabel>
<fieldlabel value="Industry">null</fieldlabel>
<fieldlabel value="No of Employees">0</fieldlabel>
<fieldlabel value="Annual Revenue">0.0</fieldlabel>
<fieldlabel value="Rating">null</fieldlabel>
<fieldlabel value="CAMPAIGNID">null</fieldlabel>
<fieldlabel value="Campaign Source">null</fieldlabel>
<fieldlabel value="SMCREATORID">22222222</fieldlabel>
<fieldlabel value="Created By">jkbmahesh</fieldlabel>
<fieldlabel value="MODIFIEDBY">22222222</fieldlabel>
<fieldlabel value="Modified By">jkbmahesh</fieldlabel>
<fieldlabel value="Created Time">2009-02-22 18:20:38</fieldlabel>
<fieldlabel value="Modified Time">2009-10-05 16:01:32</fieldlabel>
<fieldlabel value="Street">null</fieldlabel>
<fieldlabel value="City">null</fieldlabel>
<fieldlabel value="State">null</fieldlabel>
<fieldlabel value="Zip Code">null</fieldlabel>
<fieldlabel value="Country">null</fieldlabel>
<fieldlabel value="Description">null</fieldlabel>
<fieldlabel value="Skype ID">null</fieldlabel>
<fieldlabel value="Email Opt Out">false</fieldlabel>
<fieldlabel value="Salutation">null</fieldlabel>
<fieldlabel value="rrr">null</fieldlabel>
<fieldlabel value="int field">null</fieldlabel>
<fieldlabel value="Currency (Round Up)">null</fieldlabel>
<fieldlabel value="Auto Num">1</fieldlabel>

</row>
<row no="2">
...
</row>
</Leads>

</result>
</response>

この例では、データ内に「null」値があっても全項目が取得されます。タブに150項目ある場合も、全項目のデータを取得する必要があります。そのため、帯域幅が無駄に使用されます。新しい形式：

<response uri="/crm/private/xml/Leads/getAllRecords">
<result>
<Leads>
<row no="1">
< FL val ="LEADID">1111111111</ FL >
<FL val="SMOWNERID">1111122222</FL>
<FL val="Lead Owner">soori</FL>
<FL val="Company">NiveSoft</FL>
<FL val="First Name">Mutha</FL>
<FL val="Last Name">Raja</FL>
<FL val="Email"></FL>
<FL val="Phone">3434343</FL>
<FL val="No of Employees">0</FL>
<FL val="Annual Revenue">0.0</FL>
<FL val="SMCREATORID">22222222</FL>
<FL val="Created By">jkbmahesh</FL>
<FL val="MODIFIEDBY">22222222</FL>
<FL val="Modified By">jkbmahesh</FL>
<FL val="Created Time">2009-02-22 18:20:38</FL>
<FL val="Modified Time">2009-10-05 16:01:32</FL>
<FL val="Email Opt Out">false</FL>
<FL val="Auto Num">1</FL>
</row>
<row no="2">
....
</row>
</Leads>
</result>
</response>

この例では、newFormat=1パラメーターを渡すことにより、「null」値を含む項目を取得していません。重要なポイント：

  • XMLタグは、<fieldlable value="">項目値</fieldlable>から<FL val="">項目値<FL>に変更されています。
  • APIリクエストでnewFormat=1を渡すことにより、「null」値を持つデータの取得を停止できます。全項目（null値を含む）を取得する場合は、newFormat=2パラメーターを使用してください。

新しいレスポンス形式 - 2009年10月22日より提供開始

古いレスポンス形式のEOL：2010年1月21日

APIリクエスト数

パフォーマンスと開発者サービスを向上させるため、以下のようにAPIリクエスト数を制限してください。

Zoho CRMプランAPIリクエスト数 - 上限
無料プラン - 3ユーザー無料250呼び出し/日/組織
プロフェッショナルプラン - 12 USD/ユーザー/月

250呼び出し/日/ユーザーライセンス、または
最大：5,000呼び出し/日/組織、最小：1,000呼び出し/日/組織

スタンダードプラン - 20 USD/ユーザー/月

250呼び出し/日/ユーザーライセンス、または
最大：10,000呼び出し/日/組織、最小：2,000呼び出し/日/組織

エンタープライズプラン - 35 USD/ユーザー/月500呼び出し/日/ユーザーライセンス、または
最大：25000呼び出し/日/組織、最小：3000呼び出し/日/組織

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

注：

  • getSearchRecordsまたはgetCVRecordsメソッドを使用する場合、ご利用のZoho CRMプランに関係なく、1日あたり最大250呼び出しを送信できます。

重要：

上記の制限は、すべての既存ユーザーと新規ユーザーに適用されます。将来的には、お客さまの組織が上記の制限を超えるとCRM管理者（Zoho CRMアカウントの特権管理者）に通知する予定です。また、連携要件をより的確に評価するAPI統計情報も提供します。

実装日：2010年1月21日

2010年1月21日（12:00 AM PST）より、ご利用のZoho CRMプランに従ってAPI呼び出しをリクエストできます。アプリケーションが上限を超える呼び出しを必要とした場合、追加のAPIリクエストは処理されません。データ転送の問題を回避するには、API要件を事前に評価してください。サポートが必要な場合は、Zohoのサポート（support@zohoccrm.com）までお問い合わせいただくか、0120-007-542までお電話ください（英語対応）。

新しいAPIメソッド

Zohoは、成長し続ける開発者コミュニティのために以下の新規メソッドを導入いたします。

  • getSearchRecords
  • getSearchRecordsByPDC
  • deleteRecords
  • convertLead
APIメソッド目的
getSearchRecords

APIリクエストで指定した全ユーザーデータを取得します。

getSearchRecordsByPDC

Zoho CRMデータの標準項目に基づいて値を検索します。

deleteRecords

IDを渡してデータを削除します。

convertLead見込み客を取引先、連絡先、商談に変換します。

上記のメソッドは検索機能の実装に非常に有効で、ZohoのAPIによる追加のビジネスロジックの開発に役立ちます。これらのメソッドは、すべてのプランですぐに使用できるようになります。

提供開始：2009年10月22日

新しいAPIメソッドの詳細については、APIガイドを参照してください。

その他の変更点

さらに、以下のような小さい変更も行っています。

  • APIリクエストごとに最大200データを取得
  • すべてのAPIメソッド（新規メソッドと既存メソッド）に適用可能な新しいレスポンス形式
  • selectColumnsパラメーターを使用して、指定した項目を持つデータを取得
  • APIガイドを更新し、公式開発者フォーラムを開設