リクエスト形式

リクエストメソッド

Catalyst APIはREST標準に準拠しており、以下の目的に対してクライアントリクエスト用の以下のHTTPメソッドをサポートしています:

GET : Catalystリソースからレコードを取得する
POST : Catalystリソースに新しいレコードを挿入する
PUT : Catalystリソースの既存レコードを更新する
DELETE : Catalystリソースの既存レコードを削除する

Catalyst APIリクエストを実行する際に、操作のリクエストメソッドを指定する必要があります。

リクエストURL

APIリクエストはCURL形式で送信されます。一般的なリクエストURLの形式は以下のとおりです:

https://api.catalyst.zoho.com/baas/v1/project/{project_id}
/{resource_name}/{additional_resource_details}

注意: 他のデータセンターのベースAPI URLは以下のとおりです:

EU: https://api.catalyst.zoho.eu
IN: https://api.catalyst.zoho.in
AU: https://api.catalyst.zoho.com.au
CA: https://api.catalyst.zohocloud.ca
JP: https://api.catalyst.zoho.jp
SA: https://api.catalyst.zoho.sa

リクエストURLで渡される一般的なパラメーターには、CatalystプロジェクトのプロジェクトIDと、アクセスする特定のリソースインスタンスのリソースIDが含まれます。

リクエストヘッダー

cURLリクエストで渡される必須ヘッダーは以下のとおりです:

Authorizationヘッダー: OAuthトークン（access_token）

cURLリクエストで渡される推奨ヘッダーは以下のとおりです:

Content-Type: 渡されるリソースのメディアタイプを示すREST API標準です。たとえば、APIリクエストにJSONペイロードやフォームデータが含まれる場合、このヘッダーを渡すことを強く推奨します。

cURLリクエストで渡される任意のヘッダーは以下のとおりです:

Org ID: デフォルト以外の組織のOrg ID。Org IDはCatalystコンソールのマルチOrgポータルから取得できます。

注意: リクエストにOrg IDを明示的に渡さない場合、APIはデフォルトの組織に対して実行されます。

Environment: リクエストが実行される環境を指定する環境ヘッダー。APIリクエストをプロジェクトの開発環境と本番環境のどちらで実行するかを指定できます。

注意: プロジェクトが本番環境にデプロイされている場合、このヘッダーで開発環境を明示的に指定しない限り、デフォルトではAPIリクエストは本番環境で実行されます。プロジェクトが本番環境で利用できない場合、すべてのAPIリクエストは自動的に開発環境で実行されます。

リクエストボディ

リクエストの目的に応じて、API呼び出しのリクエストボディに追加データを渡すことができます。たとえば、テーブルのカラムを更新するためのカラム名と値、フォルダーを作成するためのフォルダー名などです。

ヘッダーやリクエストで渡すJSON属性など、送信するリクエストの詳細は、各APIヘルプページで指定されています。

APIリクエスト例
copy

curl “https://api.catalyst.zoho.com/baas/v1/project/4000000006007/segment/4000000006023/cache"
-X POST
-d ‘{“cache_name”:“City”,“cache_value”:“London”}’
-H “CATALYST-ORG: 15090237”
-H “Environment:Development”
-H “Content-Type:application/json”
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57"”

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit