Zoho CRM APIバージョン1.0の提供終了
API バージョン2.0提供開始:2018年2月
Zoho CRM APIの最新バージョンが公開されました。APIの呼び出しメソッドや出力レスポンスなどの変更を含む、既存APIのメジャーアップグレードです。新しいAPIでは、GET、POST、PUT、DELETEなどの単純なHTTPメソッドを使用します。入力とレスポンスのデータ形式は、同じ(JSONオブジェクトなど)です。これにより、XML形式と比べて大幅に高い精度で、大量のデータを送信/取得できるようになりました。
APIの最新バージョンは、旧バージョンの機能をすべて備えている上、さらに多くの機能を提供します。旧バージョン(1.0)は提供を終了したため、新しいAPIを使用することをお勧めします。詳細については、ヘルプドキュメントを参照してください。
API バージョン2.0を使用する機能
- OAuth 2.0 - OAuth2.0プロトコルでは、ユーザー名とパスワードを保護しながら、特定のデータを任意のアプリケーションと共有できます。このプロトコルは、安全で簡単な認証方法をユーザーに提供します。
- 接続 - 接続は、任意の外部アプリケーションのREST APIを呼び出し、関数またはウィジェットから認証済みデータにアクセスするために使用する、単純な認証メカニズムです。
- 関数 - Zoho CRMの関数を使用すると、単純なプログラムスクリプトを実行して、関連するCRMタブや外部アプリケーションのデータを更新できます。関数を使用して、(Zoho Creatorによる)Delugeスクリプトを使用してスクリプトを作成したり、スクリプトをワークフロー、カスタムボタン、関連リスト、スケジュールなどに関連付けたりすることができます。
バージョン1.0にはない、API バージョン2.0の機能
- API呼び出しごとにスコープが適用され、OAuth 2.0を使用したセキュリティが向上しました。これによってトークンが1時間で無効になるため、トークンが開示された場合でも悪用できなくなります。また、マルチDCサポートも追加しました。
- API呼び出しの1日当たりの上限数が見直され、1日当たり100,000回まで呼び出しできるようになりました(アルティメットプランの場合、上限数は1日当たり200,000回です)。
- API バージョン2.0はREST標準に準拠しており、JSON解析を容易にします。これにより、すべてのAPIが同様のレスポンス構造に従います。
- 新しいAPIダッシュボードにより、使用状況をより的確に分析できます。
- カスタム項目とカスタムタブの名前(ラベル)を変更しても既存の連携に影響しないよう、「API名」が導入されました。
既存のAPI V1コードベースをAPI バージョン2.0に移行するには、APIの移行と相違点に関するドキュメントを参照してください。
スケジュール
古いバージョンに別れを告げるときが来ました。この変更に備え、APIロードマップを明確に理解できるよう、カレンダーに重要な日付を書き留めてください。
バージョン1.0提供終了日:2018年12月31日
- 提供終了日を過ぎると、V1(旧)バージョンの問題修正、APIサポート、機能強化は行われなくなり、V1 APIメソッドは、すべて非推奨に設定されます。
- 既存コードで使われているV1 APIは、提供終了日を過ぎても動作しますが、以下に示す完全終了日以降は動作しなくなります。
バージョン1.0の完全終了日:2019年12月31日
古いAPIメソッドは、すべて使用できなくなります。つまり、V1に基づいて記述されたすべてのコードが動作しなくなります。