メイン コンテンツをスキップする 補完的コンテンツへスキップ

APIを保護

コンシューマーの認証情報を作成して、HTTPSを設定すると、APIを保護します。

コンシューマーを管理

基本認証またはAPIキー認証を使うと、データセットから生成されたAPIにアクセスできます。許可されたコンシューマーを追加する時に、API設定フォームで認証方式を選択します。

  • 基本認証の場合は、コンシューマーのユーザー名とパスワードを定義します。

    APIを呼び出すには、[Authorization] (認証)ヘッダーを追加する必要があります。値は、Base64でエンコードされたusername:passwordという文字列に後続されるBasicである必要があります。たとえば: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

  • APIキー認証の場合は、リクエストのヘッダーで生成されたキーを使います。

    APIを呼び出すには、[Authorization] (認証)ヘッダーを追加する必要があります。値は、API設定中に生成されるAPIキーに後続されるTokenである必要があります。たとえば: Token apic.data-api_3KF0MT_EalJeneqZZC3BVTm9J3ft6s66vAb3g_EgI0K7

HTTPSを使用

Remote Engine Gen2接続でデータセットをお使いの場合は、APIのHTTPSを設定できます。この操作は、Remote Engine Gen2ディレクトリーにあるdefault/nginxフォルダーでNGINX設定をアップデートして行います。

情報メモ重要: HTTPS設定に切り替えると、HTTPで使われるサーバーポートは8080ではなく8443となります。

基本HTTPS設定が構成しやすくなるよう、default/nginx/nginx.confファイルにはコメント月の設定例が含まれています。

  1. 次の行をコメントします。
     listen              9102; # Do not change this port number
  2. 次の行をコメント解除します。
    # listen              9103 ssl;  # Do not change this port number
        # ssl_certificate     cn.crt;    # The name of your public certificate file. Put it next to this nginx.conf
        # ssl_certificate_key cn.key;    # The name of your private key file. Put it next to this nginx.conf

    .crtファイルと.keyファイルはdefault/nginxフォルダーに配置する必要があります。

  3. .crtファイルと.keyファイル用のdefault/nginx/nginx.confが実際のファイル名に対応していることを確認してください。
これを設定するにはさまざまな方法があります。詳細設定については、NGINXドキュメンテーションをご覧ください。
情報メモヒント: NGINXでは、Let's Encryptからの無料SSL証明書を使えます。詳細は、NGINXブログをご覧ください。

このページは役に立ちましたか?

このページまたはコンテンツにタイポ、ステップの省略、技術的エラーなどの問題が見つかった場合はお知らせください。