Search

設定ページ

Version 25.3.9411

設定ページ

API Server アプリケーションの設定ページには、グローバルユーザー設定が含まれています。以下のセクションでは、設定ページのそれぞれのタブの用途を説明します。

サーバータブ

設定ページのサーバータブでは、API Server API に関連する設定を制御できます。このタブには4つのセクションがあります：

  • 信頼されたIP アドレス

  • OData

  • デフォルトユーザー設定

  • クロスオリジンリソース共有（CORS）

信頼されたIP アドレス

このセクションでは、API Server API への接続の作成を許可するIP アドレスを定義します。次の機能が利用可能です。IP アドレスを編集または削除するには、右側にあるドットをクリックします。

  • IP アドレスを追加：新しいIP アドレスの範囲を入力できるダイアログボックスを開きます。

  • 編集：選択されたIP アドレスの範囲を編集できるダイアログボックスを開きます。

  • 削除：選択されたIP アドレスの範囲をリストから削除します。

この設定には次の制約が適用されます。

  • API Server API への接続には、localhost が常に許可されます。この動作は変更することができません。

  • 範囲に対応しています。例えば、エントリ100.10.100.1-15 は、100.10.100.1 から100.10.100.15 までのIP アドレスが許可されることを示します。その範囲外のIP アドレスは拒否されます。

  • ワイルドカードのパターンに対応しています。例えば、エントリ100.10.100.* は、100.10.100 で始まるIP アドレスが許可されることを示します。その範囲外のIP アドレスは拒否されます。

OData

このセクションでは、OData 設定を行います。利用可能な設定は次のとおりです。編集アイコン（）をクリックして、設定を調整します。

  • サーバーサイドページングサイズ：結果を返す際のサーバーのページサイズを設定。デフォルト値は0で、すべてのレコードを単一のレスポンスで返します。

  • デフォルトフォーマット：OData が結果を返す際のデフォルト形式を設定。JSON またはXML から選択します。デフォルト設定はJSON です。

  • デフォルトバージョン：OData に使用するデフォルトのバージョンを設定。デフォルト設定はOData 4.0です。

  • ベースURL：アプリケーションがゲートウェイの背後でホストされている場合は、ベースURL をパブリックにアクセス可能なURL に設定します。例えば、https://my_website.com です。

保存をクリックして、新しい設定を保存します。

デフォルトユーザー設定

次のデフォルトのユーザー設定は、すべてのAPI Server ユーザーに適用されます。編集アイコン（）をクリックして、設定を調整します。

Note：ユーザー固有の設定を行うには、ユーザーページを参照してください。ユーザー固有の設定は、サーバー全体に対する設定をオーバーライドします。ユーザー設定のいずれかの値が空の場合は、代わりにサーバーのデフォル値が使われることを意味します。

すべてのユーザーに対して次のオプションを設定できます：

  • 1時間あたりのリクエスト数：ユーザーごとの1時間あたりの最大リクエストを入力します。無制限にアクセスできるようにするには-1 に設定します。
  • 最大同時リクエスト：ユーザーごとに許可される同時リクエストの最大数を入力します。同時リクエスト数を無制限にするには-1 に設定します。
  • トークン有効期限：ユーザーのトークンの有効期限が切れるまでの日数を入力します。

保存をクリックして、デフォルトのユーザー設定を保存します。

クロスオリジンリソース共有（CORS）

CORS によって、ブラウザベースのクライアントからAPI Server アプリケーションに接続することができます。CORS がない場合、ブラウザにより同一オリジンポリシーが強制されるため、ブラウザベースのスクリプトはAPI Server API に接続できません。このポリシーは、クライアントサイドスクリプトおよびドキュメントが、自身のオリジン以外のリソースを複製することを制限します。スクリプトのオリジンは、プロトコル、ホスト、およびポートから成ります。

編集アイコン（）をクリックして、CORS 設定を調整します。クロスオリジンリソース共有（CORS）を有効化するを選択し、次のオプションを使用してCORS を設定します：

  • すべてのドメインを ‘*’ なしで許可：このトグルをON にすると、クライアントから渡されたオリジンをAccess-Control-Allow-Origin ヘッダーで返すことで、あらゆるオリジンを許容できるようになります。

  • Access-Control-Allow-Origin：API Server がCORS で参加するオリジンを入力します。API Server は、これらのオリジンをAccess-Control-Allow-Origin ヘッダーで返します。これが ‘*’ に設定されている場合、API Server はあらゆるオリジンを許容し、Access-Control-Allow-Origin ヘッダーで’*’ を渡します。これはパブリックAPI に適しています。

  • Access-Control-Allow-Credentials：このトグルをON にすると、クライアントにクレデンシャルを要求します。

  • Access-Control-Allow-Methods：許容されるメソッドのリストをカンマ区切りで入力します。

  • Access-Control-Allow-Headers：スクリプトにより作成されたリクエストにおいて使用できるヘッダーのリストをカンマ区切りで入力します。

  • Access-Control-Max-Age：ユーザーエージェントがpreflight リクエストをキャッシュできる時間（秒単位）を入力します。デフォルトは3600 です。

保存をクリックしてCORS 設定を保存します。

通知タブ

通知タブでは、OData でエラーが発生した場合に送信されるE メール通知を設定できます。

エラーを知らせるアラート通知を有効にするには、次のようにグローバルメールサーバーと認証プロパティを設定する必要があります：

  1. 設定ページに移動して通知タブをクリックします。

  2. 編集アイコン（）をクリックして、OData ダイアログを開きます。

  3. エラー発生時にメールで通知するトグルをON にします。

  4. 通知を送信するために使用するSMTP メールサーバー用の次のプロパティを設定します：

    • 送信元 - 送信元テキストボックスに表示するE メールアドレスを入力します。デフォルトアドレスは[email protected] です。

    • 宛先 - 通知を送信する宛先のデフォルトE メールアドレスを入力します。

    • 件名 - E メールの件名を入力します。

    • SMTP サーバー - SMTP メールサーバー名を入力します。

    • ユーザー名 - SMTP サーバーへの認証に使用するユーザー名。

    • パスワード - SMTP サーバーへの認証に使用するパスワード。

    • SMTP ポート - SMTP サーバーに接続するポートを入力します。デフォルトポート番号は25です。

    • TLS 起動モード - 使用したいTransport Layer Security（TLS）モードを選択します。デフォルト値はSTARTTLS です。

  5. 保存をクリックすると、設定が保存され、設定ページの通知タブに戻ります。

  6. テストメールを送信をクリックして、E メール設定をテストします。

ライセンスタブ

ライセンスタブには、API Server ライセンスの詳細が表示されます。次の情報が含まれています：

  • プロダクトキー - 現在のAPI Server のプロダクトキー

  • ノードID - マシンのノードId。

  • バージョン - API Server のバージョン。

新しいライセンスを購入した場合は、ライセンスタブの編集アイコン（）をクリックして、ライセンスをインストールできます。次に、氏名、E メールアドレス、プロダクトキー（またはライセンスファイル）を入力し、利用規約に同意します。次に、保存をクリックします。