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

このヘルプページは、Creator 6のユーザーを対象としています。あなたのCreator バージョンを確認します。

1. このページで何がカバーされていますか？

Zoho Creatorとの統合のためにカスタムAPIを作成し、それを認証する方法を探ります。

次に進む前に、ここをクリックして、カスタムAPIについての知識を深めます。

2. 利用可能性

カスタムAPIは：

1. Creatorのすべてのプランで作成・管理できますが、呼び出し回数はサブスクライブしているプランによって異なります。
2. カスタムAPIは、スーパー管理者と管理者だけが作成・管理でき、その他の種類のユーザーは設定したユーザースコープに基づいてそれらを呼び出すことができます。

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のリンク 名前は、特殊文字（！@＃$％^＆amp;*。＞）を含むことはできません。

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

2. Content 種類をapplication/jsonまたはmultipart/form-dataのいずれかに選択します。これにより、リクエストデータがサーバーによってどのように解釈されるべきかが指定されます。

3. Argument 種類をキーと値またはEntire 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. アプリケーションドロップダウンから、必要なアプリケーションを選択します。

アプリケーションは現在の環境(DevelopmentまたはStage)と共にリストに表示されます。

2. 呼び出す関数をグループ化する名前空間を選択します。

注意：作成する関数に名前空間が指定されていない場合、デフォルトの名前空間に追加されます。

3. ドロップダウンから、呼び出されたときに実行されるDeluge関数を必要に応じて選択します。

1. エンドポイント URLを表示し、URLからカードをプレビューします。
2. 概要、リクエスト 本文、そして レスポンス 本文タブに表示される詳細を確認してください。
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. ページの下部にある前または次のボタンをクリックして、APIヒットのログを詳細に表示します。
   
2. ページ右上のellipsis アイコン（3つのドット）をクリックして、カスタムAPIを編集、削除、または無効にします。
   
   

4. カスタム APIの管理

1. ユーザーの管理
2. カスタムAPIの編集
3. カスタムAPIの状態に基づいたフィルター
   

ユーザーの管理

1. Creator アカウント内のMicroservicesページに移動します。
2. 右上隅のカスタム API タブをクリックします。
   
3. 必要なカスタム API カードを選択します。
   
4. ユーザーの範囲の下の(n) ユーザーをクリックして、ユーザーの範囲の設定で選択的ユーザーオプションを既に選択している場合は、他のユーザーを追加します。
5. 表示される管理 ユーザーのポップアップに、管理者とユーザーのメールアドレスを追加し、保存をクリックします。
   
   

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

カスタムAPIの編集

1. Creatorアカウント内のMicroservicesページに移動します。
2. 右上隅に位置するカスタム API タブを選択します。
3. 必要なカスタム API カード上のellipsis アイコン（三つのドット）をクリックします。
4. APIの編集を選択し、カスタムAPIを修正します。カスタム API のビルダーが表示されます。
   
   
5. 各セクションで必要な変更を行い、変更をプレビューした後に保存を選択します。

カスタムAPIの状態に基づくフィルター

1. Creatorアカウント内のMicroservicesページに移動します。
2. 右上隅のカスタム API タブを選択します。
3. カスタム API タブの右隅にあるフィルター アイコンをクリックします。
   
   
4. ステータス - 有効、無効または下書きを選択し、それぞれの段階で作成されたカスタムAPIを表示します。

カスタムAPIの削除と無効化

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

2. 右上隅のカスタム API タブを選択します。

3. 必要なカスタム API カード上のellipsis アイコン (三つのドット)をクリックします。

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を呼び出すためには、エンドポイントURLを外部サービスからコピーし、定義した処理を実行したいサービスで使用します。このエンドポイントURLは、あなたのカスタムAPIの詳細表示からコピーできます。

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ビルダーを保存せずに閉じると、変更はドラフトとして保存され、マイクロサービス > カスタムAPI > 必要なカスタムAPIカードからいつでも編集を続けることができます。
6. 無効なAPIを呼び出すと、レスポンスは空となり、APIログにデータが作成されますが、APIヒットとしては登録されません。
7. あなたのカスタムAPIで使用されている関数を削除する前に、関連するカスタムAPIを削除する必要があります。
   
8. 認証の種類を公開鍵として選択した場合、カスタムAPIを呼び出す前に同じ公開鍵をエンドポイントURLのパラメータに追加する必要があります。例えば、公開鍵を追加したエンドポイントURLは次のようになります：

1. https://www。zohoapis。com/creator/カスタム/ / ?publickey=<値>

7. 制限事項

1. Responseタブ内には、最大で50のステータスコードを含めることができます。
2. あなたのカスタムレスポンスコードは最大4桁である必要があります。

8. 関連トピック

1. カスタムAPIの理解
   
2. カスタムAPIのステータスコード
3. CreatorのRest API