Catalyst API入門

概要

Catalyst APIは、アプリケーション開発者がアプリケーション内でCatalystコンポーネントをリモートで操作するための幅広い機能を提供します。APIを使用してCatalystアプリケーションを構築・管理したり、Catalyst Webコンソールを使用する場合と同様にリモート操作を実行したりすることができます。

たとえば、各APIを使用して、Data Storeのテーブルへのデータ挿入、関数の実行などの操作を行うことができます。

CatalystはREST API標準を実装しており、リソースへのアクセスにHTTPリクエストとレスポンスをサポートしています。CatalystリソースはエンドポイントURLを通じて公開されており、HTTPクライアントは各エンドポイントに対応するAPIを使用してアクセスできます。

Catalystは以下の基本的なREST API原則を実装しています:

• Catalystリソースの各インスタンスのエンドポイントURLは一意です。
• リクエスト内のHTTPメソッドが、リソースに対して実行される操作を決定します。
• 追加のペイロード情報はリクエストのパラメーターとして渡されます。これには実行する操作の詳細が含まれます。
• 各リクエストはCatalystからのレスポンスを開始します。

詳細と例については、リクエスト形式およびレスポンス形式セクションを参照してください。

前提条件

Catalyst APIの使用を開始する前に、以下の前提条件を満たしていることを確認してください:

• 有効なZohoユーザーアカウント: 有効なZohoログインメールアドレスとパスワードを持っていることを確認してください。Zohoアカウントはこちらから登録できます。
• 認証トークン: Catalyst APIにアクセスするには、有効なOAuth access_tokenを取得する必要があります。

OAuth 2.0認証セクションのヘルプページで、認証トークンの理解と取得のプロセスについてご案内します。

すべてのCatalyst APIは、Catalyst App Administratorロールのユーザー（Catalystアプリケーション開発者）がaccess_tokenを取得した後にアクセスできます。特定のプロジェクトのすべてのコラボレーターも、access_tokenを使用してすべてのCatalyst APIを実行できます。

ただし、App Userロールのユーザー（Catalyst認証を持つCatalystアプリケーションのエンドユーザー）がアクセスできるのは、特定の操作のみです。エンドユーザーは、特定のアプリケーションデータへのアクセスに関連する操作のみを実行でき、アプリケーションを変更する操作は実行できません。各APIヘルプページでは、定義された実行権限に関する情報が提供されます。