お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

このヘルプページは Creator 6 をご利用のユーザー向けです。ご利用中のCreator のバージョンを確認してください。

1. このページの内容

カスタム API を作成し、Zoho Creator と連携できるよう認証する方法を説明します。

先に進む前に、こちらをクリックして、カスタム APIの概要をご確認ください。

2. 利用条件

カスタム API は次のとおりです。

1. すべてのプランの Creator で作成および管理できますが、呼び出し上限は契約プランによって異なります。
2. スーパー管理者と管理者のみが作成および管理できます。他の種類のユーザーは、設定されたユーザースコープに基づいて呼び出すことができます。

3. カスタム API の作成

3。1 カスタム API の作成フロー

3。2 設定方法を確認する

3。3 カスタム API を作成・管理する手順

1. カスタム API を作成する
2. カスタム API の詳細を表示する
3. カスタム API を管理する
4. カスタム API を削除・無効化する
5. カスタム API を呼び出す

初めてカスタム API を作成する場合は、カスタム APIタブを選択し、+ カスタム API を作成をクリックすることもできます。カスタム API ビルダーが表示されます。アクセスできるのはスーパー管理者と管理者のみです。

カスタム API には、その機能を表し、覚えやすく、意味がわかりやすい名前を付けることが重要です。

カスタム API のリンク名には、!@#$%^&*.> などの特殊文字は使用できません。

これらのメソッドを実行するには、Zohocreator.customapi.execute スコープが必要です。

2. コンテンツタイプとして application/json または multipart/form-data のいずれかを選択します。これは、サーバー側でリクエストデータをどのように解釈するかを指定するために使用されます。

3. 引数タイプとして キーと値 または JSON 全体 のいずれかを選択します。詳細を見る

カスタム API の引数タイプとして「JSON 全体」を選択する場合は、文字列データ型の引数を 1 つだけ指定してください。

4. 認証タイプとして OAuth2 または 公開キー を選択します。既定では OAuth2 が選択されています。

1. 管理者のみ - スーパー管理者と管理者
2. 特定のユーザー - スーパー管理者、管理者、およびこのオプション選択時に入力欄でメールアドレスを指定したユーザー
3. ポータルユーザー- ポータルユーザーのうち、処理 タブで選択したアプリケーションのポータルに追加され、承認されているユーザー

メモ: ポータルユーザーを選択した場合、カスタム API はウィジェット内からのみ呼び出すことができます。詳細を見る

1. すべて- Creator アカウントのユーザー タブに表示されている、すべての有効なユーザー

カスタムレスポンスでは、ステータスコードとそれに対応するレスポンスコードを指定できます。

1. 標準レスポンスタイプを選択した場合、レスポンスにはステータスコードが返されます。
   
   
2. カスタムオプションを選択した場合、下部にカスタムレスポンスを追加スライダーが表示されます。
   
1. 適切なステータスコードを入力します。たとえば、200、202、401 などのステータスコードを入力できます。
   
2. 入力したステータスコードに対応するレスポンスコードを入力します。たとえば、2002、3400、4434 などのレスポンスコードを指定できます。
   
   

手順 4: 関数実行の詳細を指定する

処理タブで、呼び出し時に実行する関数の詳細を指定します。

1. Applicationドロップダウンから、対象のアプリケーションを選択します。

アプリケーションは、現在属している環境（Development または Stage）が併記された状態で一覧表示されます。

2. 呼び出したい関数が属している該当の名前空間を選択します。

メモ: 作成した関数に名前空間を指定していない場合、その関数は初期設定名前空間に追加されます。

3. ドロップダウンから、呼び出し時に実行する対象のDeluge 関数を選択します。

1. URL プレビューカードからエンドポイント URL を表示します。
2. 概要、Request 本文、Response 本文タブに表示される詳細を確認します。
3. 変更を行う場合は戻るをクリックして前のタブに戻します。カスタム API は下書きとして保存されます。
4. 変更内容を確認したら保存をクリックします。カスタム API が正常に作成され、作成したカスタム API の詳細表示ページに移動します。

API ヒット数を表示できるのはスーパー管理者と管理者のみです。一般ユーザーは API ヒット数を表示できません。

1. Creator アカウントでMicroservicesページに移動します。
2. 右上のカスタム APIタブをクリックします。
3. 対象のカスタム API カードをクリックします。詳細表示ページが表示されます。
   
   

1. 過去 60 日の横にあるドロップダウン矢印をクリックして、異なる期間の API ログを表示します。API ログは初期設定で過去 30 日間のログが表示されます。
   
   
2. フィルターアイコンをクリックし、ステータスコードまたはAPI ステータス（完了または失敗）に基づいて API ヒット数を表示し、適用をクリックします。
   
1. ステータスコードを選択した場合は、対象の値を入力し、適用をクリックします。
   
2. API ステータスを選択した場合は、完了または失敗のいずれかを選択し、該当するログを表示します。
   
   

また、失敗ステータスをクリックして、追加のエラー詳細を表示することもできます。

1. ページ下部のPrevまたは次ボタンをクリックして、その他の API ヒットログを表示します。
   
2. 右上の省略記号アイコン（三点リーダー）をクリックして、カスタム API を編集、削除、または無効化します。
   
   

4. カスタム API を管理する

1. ユーザーを管理する
2. カスタム API を編集する
3. カスタム API の状態でフィルターする
   

ユーザーを管理する

1. Creator アカウントでMicroservicesページに移動します。
2. 右上のカスタム APIタブをクリックします。
   
3. 対象のカスタム API カードを選択します。
   
4. ユーザースコープのユーザー Scopeで(n) ユーザーをクリックし、ユーザースコープ設定で選択したユーザーオプションを選んでいる場合に、追加のユーザーを追加します。
5. 表示される管理ユーザーポップアップで、管理者およびユーザーのメールアドレスを追加し、保存をクリックします。
   
   

メモ: API 詳細表示ページ内ではユーザー Scopeを編集できません。

カスタム API を編集する

1. Creator アカウントでMicroservicesページに移動します。
2. 右上のカスタム APIタブをクリックします。
3. 対象のカスタム API カードの省略記号アイコン（三点リーダー）をクリックします。
4. API を編集をクリックしてカスタム API を編集します。カスタム APIビルダーが表示されます。
   
   
5. 各セクションで必要な変更を行い、変更内容をプレビューしたうえで保存をクリックします。

カスタム API の状態でフィルターする

1. Creator アカウントでMicroservicesページに移動します。
2. 右上のカスタム APIタブをクリックします。
3. カスタム APIタブ右側のフィルターアイコンをクリックします。
   
   
4. 有効、無効、下書きのいずれかのステータスを選択し、各ステータスで作成されたカスタム API を表示します。

カスタム API を削除・無効化する

1. Creator アカウントでMicroservicesページに移動します。

2. 画面右上のカスタム APIタブをクリックします。

3. 対象のカスタム API カードで、省略記号アイコン（3 点リーダー）をクリックします。

4. カスタム API を無効化するには、無効にするオプションを選択します。

無効な API を呼び出した場合、空のレスポンスが返されます。無効な API を呼び出すと API ログにはデータが記録されますが、API ヒットとしてはカウントされません。

5. 表示されるカスタム API を無効にするポップアップで無効にするをクリックします。該当する API はMicroservicesセクションで無効になります。

必要に応じて有効にするをクリックして、再度有効化できます。

6. 対象のカスタム API を削除するには、削除をクリックします。

メモ: カスタム API を削除すると、Microservicesからは削除されますが、そのカスタム API に関連付けられている関数は、対応する Creator アプリケーション内に保持されます。

1. カスタム API で使用中の関数を削除する前に、先にその関数に関連付けられているカスタム API を削除する必要があります。
   
2. カスタム API で現在使用されている関数を更新すると、その API は更新後の関数の最新バージョンに自動的に構成されることが通知されます。

5. カスタム API の呼び出し

カスタム API を呼び出す前に、以下の各見出しで説明している手順を実行する必要があります。作成したカスタム API を呼び出すには、外部サービスで定義済みの処理を実行したい場所から、カスタム API の詳細表示でコピーしたエンドポイント URLを使用します。

1. クライアントアプリケーションを登録する
2. 認可コードをリクエストする
3. アクセストークンと更新トークンを生成する
4. アクセストークンを更新する
5. 更新トークンを取り消す

1. 認証の種類として OAuth2 を選択した場合、指定したユーザーまたは管理者が認証され、任意の外部プラットフォームからエンドポイント URL を直接呼び出せます。
   
2. 認証の種類として公開キーを選択した場合、公開キーは API の詳細表示ページに表示されます。このキーをエンドポイント URLのパラメーターとして付加する必要があります。
   
3. Creator アプリケーション内の任意のユーザーは、この公開キーを使用してカスタム API を呼び出すことができます。
   

6. 注意点

1. カスタム API のリンク名には、!@#$%^&*.> などの特殊文字を含めることはできません。
   
2. カスタムレスポンスのステータスコードは、100 ～ 599の範囲で指定できます。
3. カスタムレスポンスのレスポンスコードは1 ～ 9999の範囲である必要があり、!@#$%^&*.> などの特殊文字を含めることはできません。
4. カスタム API のユーザー範囲を選択したユーザーから管理者のみ、ポータルユーザー、またはすべてに変更すると、以前に追加したユーザーはすべて削除されます。
5. カスタム API ビルダーを保存せずに閉じた場合でも、変更内容は下書きとして保存されます。Microservices > カスタム API > 対象のカスタム API カードから、いつでも編集を再開できます。
6. 無効な API を呼び出した場合、空のレスポンスが返されます。つまり、無効な API を呼び出すと API ログにはデータが記録されますが、API ヒットとしてはカウントされません。
7. カスタム API で使用中の関数を削除する前に、先にその関数に関連付けられているカスタム API を削除する必要があります。
   
8. 認証の種類として公開キーを選択した場合、カスタム API を呼び出す前に、同じキーをエンドポイント URLのパラメーターとして付加する必要があります。例として、公開キーを付加したエンドポイント URLは次のようになります。

1. https://www.zohoapis.com/creator/custom/<account_name>/<app_name>?publickey=<value>

7. 制限事項

1. Responseタブでは、最大50個までステータスコードを追加できます。
2. カスタムレスポンスコードは、最大4 桁まで指定できます。

8. 関連トピック

1. カスタム API について
   
2. カスタム API ステータスコード
3. Creator の REST API