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

このヘルプページは、Creator 6のユーザー向けに設計されています。あなたのCreator バージョンを特定してください。

1. このページがカバーするものは何か？

Zoho Creatorとの統合のために、カスタムAPIを構築し認証する方法を発見します。

次に進む前に、ここをクリックしてカスタムAPIに関するその他の洞察を得てください。

2. 可用性

カスタムAPIは次のような特性を持っています：

1. Creatorのすべてのプライシングプランで設立・管理できます。ただし、無料プランではカスタムAPIの呼び出し頻度が制限されます
2. スーパー管理者と管理者のみがカスタムAPIの設立、認証、および管理ができます。他のユーザーはそれらにアクセスできます
3. すべてのデータセンターでアクセス可能です

3. カスタムAPIの作成

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

3。2 設定方法

3。3 カスタムAPIを設立・管理するための手順

1. カスタム API を構築する
2. カスタム API の詳細を表示する
3. カスタム API を管理する
4. カスタム API を削除し、無効にする
5. カスタム API を呼び出す

カスタム API を設立する

カスタム API のテストは開発環境中 のみ Deluge 関数が利用可能なため可能であり、 本番環境 ではカスタム APIとして公開できます。

1. あなたのCreatorアカウント内のマイクロサービスページへ移動してください。

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

カスタムAPIの名前を選ぶ際は、直感的で覚えやすく、その機能を示す名前を選ぶことが重要です。

カスタムAPIのリンク名には、!@#$%^&*>のような特殊文字を含めないでください。

このセクションを参照して、さまざまなメソッドでのAPI範囲を理解してください。

1. Admin Onlyを選択した場合、APIはAdminのスコープで動作します。
   
   
2. Specific ユーザーを選択した場合、APIは指定されたユーザーのみがアクセスでき、それぞれのユーザーのメールアドレスを指定することができます。
   
   

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

カスタムAPIの引数の種類を全JSONとして選択するときは、文字列データ型の引数を1つだけ指定してください。

カスタム応答を使用すると、ステータスコードとそれに対応する応答コードを指定できます。

1. スタンダードの応答タイプを選択した場合、返される応答はCreator's REST APIsの現在のステータスコードに従います。
   
   
2. カスタムオプションを選択した場合、追加する カスタム Responseスライダーが下に開きます。
   
1. 適切なステータス コードを入力します。例えば、200、202、401などのステータスコードを入力することができます。
   
2. 入力したステータスコードに対応する応答コードを入力します。例えば、応答コードは2002、3400、4434などとなることがあります。
   
   

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

処理 タブで、呼び出されたときに実行する関数の詳細を定義します。

1. 必ずアプリケーションをApplicationのドロップダウンメニューから選択します。

2. 呼び出す必要のある関数がグループ化されている名前空間を選択します。

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

3. 呼び出されたときに実行する必要のあるDeluge関数をドロップダウンメニューから選択します。

1. 差出人のURLカードでエンドポイントURLを表示します。
2. 概要、リクエスト本文、およびレスポンス本文タブに表示される詳細を認証します。
3. 前のタブに変更を加えるために戻るをクリックします。あなたのカスタムAPIは下書きとして保存されます。
4. 変更点を確認した後、保存をクリックします。カスタムAPIが正常に作成され、作成したカスタムAPIの詳細表示ページにリダイレクトされます。

スーパー管理者と管理者だけがAPIヒット（つまり、ユーザーはAPIヒットを表示できません）を表示することが可能です。

1. あなたのクリエイターアカウントのマイクロサービスページに移動します。
2. 右上隅にあるカスタムAPIタブをクリックします。
3. 必要なカスタムAPIカードをクリックします。詳細表示ページが表示されます。
   
   

1. ドロップダウン矢印をクリックし、Last 60 日の隣を表示します。これにより、さまざまな時間帯のAPIログが表示されます。APIログは、初期設定では過去30日間のログを表示します。
   
   
2. フィルターアイコンをクリックし、ステータス コードまたはAPI ステータス（完了またはfailure）に基づいてAPIヒットを表示し、その後適用するをクリックします。
   
1. ステータス コードを選択した場合、必要な値を入力し適用するをクリックします。
   
2. APIステータスを選択した場合、完了またはFailureを選択し、それぞれのログを表示します。
   
   

Failureステータスをクリックすると、追加のエラー詳細を表示できます。

1. APIヒットのログを詳細に表示するには、ページ下部のPrevまたは次ボタンをクリックします。
   
2. ellipsisアイコン（3つのドット）を右上でクリックして、カスタムAPIを編集，削除，または無効にする。
   
   

4. カスタム API の管理

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

ユーザーの管理

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

注釈: API 詳細 表示する ページ内のユーザー Scopeを編集することはできません。

カスタム API を編集

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

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

1. Creator アカウント内のMicroservices ページに続けて移動します。
2. 右上の角に位位置するカスタム API タブを選択します。
3. カスタム API タブの右側にあるフィルター アイコンを押します。
   
   
4. ステータス - 有効, 無効 または 下書き を選択し、それぞれの段階で作成したカスタムAPIを確認します。

カスタム API を削除および無効化

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

2. 右上の角に位置するカスタム API タブを選択します。

3. 必要なカスタム API カード内のellipsis アイコン（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を呼び出すには、エンドポイント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のユーザースコープをAdmins OnlyまたはSelective ユーザーに変更すると、以前に追加された全てのユーザーが削除されます。
5. カスタムAPIビルダーを保存せずに閉じても、変更は下書きとして保存され、Microservices > カスタムAPI >必要なカスタムAPIカードからいつでも編集を続けることができます。
6. 非アクティブなAPIを呼び出すと、空のレスポンスが返されます。つまり、非アクティブな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. CreatorのRest API