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

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

1. このページの目的は何ですか？

2. これはどこで利用できますか？

カスタムAPI:

1. Creatorのすべてのプランで作成および管理できますが、呼び出し回数の制限は加入されるプランによります。
2. スーパー管理者と管理者が作成と管理（追加や設定変更など）を行い、それ以外のユーザータイプは、設定されたユーザースコープに基づきこれらを起動することができます。

3. 概要

4. CreatorにおけるカスタムAPI

スーパー管理者と管理者のみがカスタムAPIビルダーにアクセスしてカスタムAPIを作成および管理できます。

メモ:

1. APIのヒット数は、REST APIのヒット数とは別に、料金設定でカウントされます。
2. 現在、既に設定されている Deluge関数のみをカスタムAPIとして使用することができます。それは、クラウド関数を使用して Java および NodeJS スクリプトとして記述したものをカスタムAPIとして呼び出すことはできません。

4.1 クリエイターにおけるカスタムAPIの機能

1. カスタムAPIは、Creatorでのみ可能な操作を実行するのに役立ちます。例えば、プッシュ通知の送信、AIフォーム項目からの結果の取得、他のデータ関連の処理の実行などが可能です。
2. ユーザーは、Deluge関数を再スクリプティングしたり、別のカスタムAPIを作成したりする代わりに、Creatorの独自のDeluge関数をカスタムAPIで呼び出すことができます。
3. データアクセスが制御されて安全であることを確認し、不正アクセスやデータ漏洩のリスクを減らすために、認証機構を実装することによって安全なカスタムAPIを作成します。
4. 単一の関数を通じて複数の論理操作を実行する。
5. 大規模な操作を複数のAPI呼び出しや外部スクリプトを通じて実行する際、一箇所で カスタムAPIのログの分析と管理を行います。

4.2 CreatorでのカスタムAPIの構築方法は？

1. カスタム API Builder ：データ交換をCreatorと外部システム間で容易にする使用可能なカスタムAPIの構築を支援する、安全で簡単に使用できるインターフェース。
2. Deluge関数 ：あなたの既存のDeluge関数は、カスタムAPIで呼び出すことができます。

4.3 CreatorのカスタムAPIのコンポーネント

1. 基本情報
2. エンドポイントURL
3. ユーザースコープ
4. リクエスト
5. 関数
6. レスポンス

基本情報

カスタム APIの名前をつける際には、その機能を反映した記憶に残るような具体的な名前を選択することが重要です。

エンドポイントURLの機能

1.エンドポイントURLの取得方法は？

次の場所からエンドポイントURLをコピーすることができます:

1. 各カスタムAPIのカード
2. 詳細表示
   

次のビデオは、エンドポイントURLをコピーできる場所を示しています。

2. エンドポイントURLにアクセスできるのは誰ですか？

ユーザースコープとは、リクエスト タブで定義され、誰がカスタムAPIにアクセスし、それを呼び出せるかを決定します。

メモ: 承認されていないユーザーがエンドポイントURLを使用してカスタムAPIを呼び出そうとすると、システムレスポンス(つまり、Creatorのレスポンス)が表示されます。

メモ:

1. エンドポイントURLは、カスタムAPIを呼び出すために必要な外部プラットフォームにコピーし貼り付ける必要があります。
   
2. カスタムAPIのリンク名を編集したり、ユーザースコープや認証方法を変更すると、エンドポイントURLのプレビューはカスタムAPIビルダー内で自動的に更新されます。ただし、呼び出された場所すべてでエンドポイントURLを手動で更新する必要があります。更新せずにカスタムAPIを呼び出すと、システムレスポンス（エラー）が表示されます。

リクエスト

1. リクエストメソッド
2. 認証
3. ユーザーの範囲
4. コンテンツ種類

カスタムAPIのリクエストメソッド

1. 取得する: このメソッドを使用すると、指定したエンドポイントURLからデータをリクエストして取得できます。取得リクエストでは、データは通常URLの最後に追加されたクエリパラメータとして送信されます。
2. POST: このメソッドでは、指定したエンドポイントURLに処理するデータを送信できます。POSTリクエストでは、データは通常JSON形式やフォームデータなどのリクエスト本文内に送信されます。ここでは、データはURLに追加されません。
3. PUT: このメソッドは指定したURLの既存のリソースを更新するか置換する、または新しいリソースを作成するために使用されます。
4. 削除: このメソッドは、指定したURLのサーバーから特定のリソースを削除するために使用されます。

認証

1.  OAuth2 - デフォルトでは、OAuth（開かれた認証という意味）はAPIの呼び出しを認証し認可し、安全なアクセスを提供します。これにより、ユーザーがログインするたびにユーザー名とパスワードを必要とすることがなくなります。このオプションが選択された場合、ユーザースコープで指定されたユーザーだけがカスタムAPIにアクセスして呼び出すことができます。
   
2. PublicKey - このオプションが選択された場合、カスタムAPIは誰でもアクセスして呼び出すことができます。

情報: 公開鍵はエンドポイントURLにパラメータとして追加する必要があります。

ユーザースコープ

1. 管理者のみ - スーパー管理者と管理者
2. 選択的なユーザー - スーパー管理者、管理者、およびいくつかのユーザーが自分のメールアドレス（このオプションが選択されているときの入力項目）で識別されます
3. ポータルユーザー - 承認済みのポータルユーザーが選択されたアプリケーションのポータルに追加されています処理タブ
   
4. すべて - 頻繁に有効なユーザーは、Creatorアカウントのユーザー タブから来ています。 これにはポータルユーザーは含まれません。

メモ:

1. カスタムAPIの選択的ユーザー から管理者のみ、ポータルユーザー、またはすべてに、ユーザースコープを変更すると、以前に追加されたすべてのユーザーが削除されます。
   
2. もし ポータルユーザーがユーザースコープとして選ばれた場合、カスタムAPIはウィジェット内からのみ呼び出すことができます。 詳細はこちら

コンテンツ種類

メモ: コンテンツ種類は、POST と PUT メソッドでのみ選択できます。

1. Application/JSON: このコンテンツタイプを選択することで、APIリクエスト内のデータがJSON（JavaScript Object Notation）形式であることを示します。これにより、外部サービスに対してリクエスト本文内のデータがJSON形式で存在し、それに応じて処理する必要があることが伝えられます。

JSONは、広く使用されているデータ交換形式であり、通常はデータオブジェクト、配列、キー-値ペアを表すために使用されます。また、人間にも機械にも読み取り可能であるため、クライアントとサーバー間で構造化されたデータを送信するために一般的に使用され、API通信に最適な選択です。

1. Multipart/form-data：このコンテンツタイプは、バイナリーやテキスト形式のデータ、例えばファイルを外部サービスに送信するAPIリクエストで使用されます。multipart/form-dataリクエストでは、データは複数の部分に分割され、各部分はそれぞれ独自のコンテンツタイプとヘッダーを持ちます。これにより、データ自体だけでなく、ファイル名、項目名、各部分のコンテンツタイプなどの追加情報も含めることができます。パーツを区別するために、ユニークな境界文字列が使用され、リクエストヘッダーで指定され、各パーツの開始と終了を示します。

Multipart/form-dataは一般的に、ユーザーがファイルをアップロードするAPIエンドポイントを作成したり、ファイルアップロード項目を含むフォームを操作する際に使用されます。ユーザーがファイル入力項目を含むフォームを送信すると、カスタムAPIはデータを外部サーバーに送信する'multipart/form-data'リクエストを生成します。

ノート：

1. Multipart/form-dataは、JSONのようにネストされたデータを持つことはできません。つまり、それは単に別々の'キー-値'ペアを含むだけです。
2. JSONとは異なり、1つのキーに複数のエントリを持つことができます。

1. キーと値：この種類では、入力パラメータをキー-値のペアとしてAPIエンドポイントに渡すことができます。これは少数の明確で名前がつけられたパラメータをAPIリクエストで渡す必要がある場合に使用されます。
   

1. 完全なJSON：この種類では、全ての必要なキー-値ペアを含む非構造化のJSONオブジェクトを丸ごと一つの引数として渡すことができます。このアプローチは、Webhookの呼び出しを処理する際に役立ちます。
   

例のリクエスト:

1. {
2. 'ユーザー':{
3. 'id':12345,
4. '名前':'Alisa',
5. 'メール':'alisa@zylker.com',
6. '年齢':28,
7. '住所':{
8. '町名・番地':'123 Main St',
9. '市区町村':'Anytown',
10. '国':'Zylkerland'
11. },
12. '注文':[
13. {
14. 'order_id':1001,
15. 'total_amount':75.50,
16. 'ステータス':'納品済み'
17. },
18. {
19. 'order_id':1002,
20. 'total_amount':102.20,
21. 'ステータス':'保留中'
22. }
23. ]
24. },
25. 'ステータス':'完了',
26. 'メッセージ':'ユーザー data retrieved successfully'
27. }

上記の例について:

1. JSON レスポンスは、さまざまなネストされた要素を含んでいます。
2. 'ユーザー'には、ID、名前、メール、年齢、住所、注文のリストを含むユーザー詳細が含まれています。
3. '住所'は、ユーザーの詳細内のネストされたオブジェクトで、住所関連情報を含みます。
4. '注文'は、ユーザーによる異なる注文を表す複数のオブジェクトを含む配列で、各注文には順番のID、合計額、ステータスなどの属性があります。
5. 'ステータス'と'メッセージ'には、APIリクエスト/レスポンスの全体的なステータスに関する追加情報が提供されています。
   

このカスタムAPI用の完了 JSONを選択する際、各キーが特定の値に関連付けていることを確認し、ここに文字列データ型の一つの引数のみを指定してください。

レスポンス

1. スタンダードレスポンス: このレスポンスは、スタンダードステータスコードを返します。このオプションが選択された場合、以下にサンプルレスポンスが表示されます。
   
   
2. カスタムレスポンス: このレスポンスでは、必要に応じてカスタムステータスコードとそれに対応するレスポンスコードを定義および指定できます。
   
   

メモ:

1. 一つのステータス コード ごとに、最大で 50のレスポンスコード を指定することができます。
2. あなたの カスタム レスポンスコードは、最大で 4桁 までしか含めることができません。
3. カスタムコードを指定すると、呼び出されるべき選択済みの Deluge関数の返却する種類はマップでなければなりません。
4. 指定したレスポンスコードをDeluge関数内の説明的なメッセージにマッピングする必要があります。

機能

処理 タブで、カスタムAPIが呼び出されたときに実行されるDelugeの functionを含むCreatorアプリケーションと名前空間を選択することができます。

1. アプリケーションは、現在の環境(開発またはステージ)が指摘されてリストされます。
2. Deluge関数を作成するときに、適切な名前空間と関数を指定することを推奨します。これにより、カスタムAPIの処理を定義するのが容易になります。
3. デリュージュ関数内に機密操作を含めるときや、ユーザスコープを通じてカスタムAPIへの呼び出しアクセスを付与するときは、注意を払うことを推奨します。

概要

もしカスタム API を作成し、保存する前にページを終了すると、そのカスタム API は下書きとして保存されます。

カスタム API の作成が成功した場合、その重要な詳細、それが使用されているアプリケーション、作成および更新の詳細を概要タブで見ることができます。

APIログ

1. APIログは、初期設定では過去30日間のログを表示し、最大で前60日間まで表示可能です。
   
2. APIヒット数を表示できるのはスーパー管理者と管理者のみであり、ユーザーはAPIヒット数を表示できません。

カスタムAPIを呼び出す範囲

メソッド	範囲
GET, POST, PUT, DELETE	Zohocreator.customapi.実行

5. 動作方法を確認する

1. 旅行が始まる前に、スタッフ、学生、非教職スタッフの全エリアのスタッフのピックアップ住所を取得します。
2. 各旅行終了時に学生の出席情報と平均旅行速度をデータ化します。

1. 3つの データ取得APIを使用して、3つの別々のレポートから住所を取得します。
2. 2つの データ追加API を使用して、旅行についての詳細と当日の出席情報をデータ化します。

6. 使用事例

1. 病院管理: あなたがクリニックを所有し、Creatorを使用して病院管理アプリケーションを作成し、センサー付きの医療機器から患者の重要な情報を取得しようとしているとしましょう。これにより、医師はすぐに警告を受け、患者のバイタルを監視し、必要に応じて医療支援を提供できます。異常な読み取りが検出されると常に呼び出されるカスタムAPIを設定できます（心拍数、血圧、酸素レベルなどの各種のバイタルを考慮）。デバイスは、これらの詳細をAPIリクエストとして送信し、モバイル通知として逐次医師に送信します。指定された医師は、Creator内のポップアップフォームで提示され（小さな緊急事態の場合）、治療を行う医療スタッフに医療アドバイスを送信します。医師は直ちに診察が必要かどうかを判断し、最も早いものを予約できます。患者は、処方された医療アドバイスと予約詳細（適用される場合）をAPIレスポンス経由で受け取ります。このデータはまた、予約と患者詳細フォームにそれぞれ追加できます。
2. 承認管理: Creatorを使用してプロジェクト管理アプリケーションを作成し、従業員が外部サービスで提案書類を作成し、それがあなた（管理者）によって承認される必要があるとしましょう。さらに、承認された書類ごとにCreatorアプリケーションにデータを追加し、却下された書類のデータを維持する必要があります。書類が提出されて外部サービスから承認が求められるときに呼び出されるカスタムAPIを作成することができます。これにより、Creatorの承認ワークフローがトリガーされ、書類の承認プロセスを開始し、書類のステータスを'承認済み'に変更します。プロジェクトの詳細レポートと見積もり詳細レポートにデータが追加されます。書類が却下された場合、書類のステータスは'却下'とマークされ、プロジェクトの詳細レポートと文書フィードバックレポートにそれぞれデータが追加されます。

7. カスタムAPI作成のためのナビゲーションガイド

8. メモする点

1. あなたのカスタムAPIのリンク名には、!@#$%^&*.>などの特殊文字を含めることはできません。
   
2. カスタムレスポンスのステータスコードは100から599の範囲内であることができます。
3. カスタムレスポンスのリスポンスコードは1から9999の範囲内でなければならず、!@#$%^&*.>などの特殊文字を含むことはできません。
4. 保存せずにカスタム APIビルダーを閉じると、あなたの変更は下書きとして保存され、いつでもMicroservices > カスタム API >必須 カスタム API カードから編集を続けることができます。
5. 無効なAPIを呼び出すと、空のレスポンスが返されます。これは、APIログには呼び出し記録が残りますが、APIヒットとしては登録されません。
6. あなたのカスタムAPIで使用している機能を削除するには、まず関連するカスタムAPIを削除しなければなりません。それから関連する関数を削除することができます。

9. 関連トピック

1. カスタム APIの作成と管理
   
2. カスタム APIのステータスコード
3. CreatorにおけるREST API