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

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

1. このページがカバーする内容は何ですか?

Zoho Creatorとの統合のためのカスタムAPIの開発と認証方法をご紹介します。

続行する前に、こちらをクリックして、カスタムAPIについての追加情報をご覧ください。

2. 利用可能性

カスタムAPI：

1. Creatorのすべての料金プランで作成し、管理できます。ただし、無料プランでは、カスタムAPIが呼び出される回数に制限があります
2. 作成、認証、管理はスーパー管理者及び管理者のみが行うことができますが、他のユーザーもアクセスできます
3. すべてのデータセンターで利用可能です

3. カスタムAPIの作成

3。1 カスタムAPI作成プロセス

3。2 設定方法

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

カスタムAPIの名前は、その機能を表す、記憶に残るような説明的な名前を選択することが重要です。

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

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

1. Admin Onlyを選択した場合、APIはAdmin's scopeで動作します。
   
   
2. Specific Userを選択した場合、APIは指定されたユーザー、つまり、対象ユーザーのメールアドレスを指定することでのみアクセス可能となります。
   
   

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

あなたがカスタム APIの引数の種類を完全なJSONとして指定するとき、必ず文字列のデータ型の引数を1つだけ指定してください。

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

1. スタンダードのレスポンス種類を選択した場合、レスポンスにはステータスコードが含まれます。
   
   
2. カスタムオプションを選択した場合、下のスライダーにカスタムレスポンスを追加が表示されます。
   
1. 適切なステータスコードを入力します。例えば、200、202、401などのステータスコードを入力できます。
   
2. 入力したステータスコードに対応するレスポンスコードを入力します。例えば、レスポンスコードは2002、3400、4434などになる可能性があります。
   
   

ステップ 4: 関数実行の詳細を定義

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

1. 必要なアプリケーションをアプリケーションドロップダウンから選択します。

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

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

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

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

APIにアクセスした回数は、スーパー管理者と管理者だけが表示できます。すなわち、ユーザーはAPIヒットを表示することはできません。

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

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

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

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

4. カスタム APIの管理

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

ユーザーの管理

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

注: 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. Microservices ページにCreator アカウントで移動します。

2. 右上隅にある カスタム API タブをクリックします。

3. 必要なカスタム API カードにある三点(ellipsis)アイコンをクリックします。

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

無効なAPIを呼び出した場合、結果は空になります。無効なAPIを呼び出すと、「APIログ」に結果が表示されますが、APIヒットとして記録されることはありません。

「無効にする」カスタムAPIポップアップに表示される無効にするをクリックします。それぞれのAPIはMicroservicesセクションで無効化されます。

それを有効にするためには有効にするをクリックします。

必須のカスタムAPIを削除するには削除をクリックします。

注釈: カスタムAPIを削除すると、Microservicesから削除されますが、該当するAPIの関連付けられていたcreatorアプリケーションには維持されます。

1. 関連付けられたカスタムAPIを削除せずに、カスタムAPIで使用している関数を削除することはできません。関連付けられたAPIを削除する前に、該当する関数を削除してください。
   
2. カスタムAPIで使用中の関数を更新すると、APIが更新関数の最新バージョンに設定される旨の通知が表示されます。

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

次に挙げる手順を実行してから、カスタムAPIを呼び出す必要があります。作成したカスタムAPIを呼び出すには、あなたのカスタムAPIのエンドポイントURLを使用します。これはthe 詳細表示でコピーし、外部サービスで定義された処理を実行するために使用します。

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. 認証種類を公開鍵とした場合、エンドポイントURLにパラメータとして追加する必要があります。例えば、公開鍵を追加したエンドポイントURLは以下のようになります。

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

7. 制限事項

1. レスポンスタブでは、50までのステータスコードを追加することができます。
2. カスタムレスポンスコードは、最大4桁まで含むことができます。

8. 関連トピック

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