Microsoft Web IQ で認証する

Microsoft Web IQ API へのアクセス権を取得するには、認証方法が 2 つあります。 最も迅速に開始するには API キーを使用し、運用環境のワークロードには Microsoft Entra ID を使用します。

API キー

Microsoft Web IQ ポータルで API キーを作成し、Microsoft Web IQ API に対して認証するために使用します。 すべてのリクエストで x-apikey ヘッダーに含めます。

x-apikey: <YOUR_API_KEY>

Warning

API キーを使用すると、アカウントへのフル アクセスが許可されます。 クライアント側のコードやソース管理ではなく、シークレット マネージャーに格納します。

Microsoft Entra ID

Microsoft Web IQ API で認証を行うには、Microsoft Entra ID OAuth 2.0 クライアント資格情報 (アプリ専用トークン) を使用します。

Note

Microsoft Entra IDはID 管理プラットフォームです。 アプリの登録には、テナント内のアプリケーションを識別し、Web IQ アカウントにバインドする値である アプリケーション (クライアント) ID があります。 実行時に、アプリは資格情報を使ってMicrosoft Entraアクセス トークンを取得し、各 API 要求と共に送信します。

Prerequisites

  1. テナントを設定します。アプリを登録するには、Azure テナントが必要です。 Azure サブスクリプションは必要ありませんが、組織に既に 1 つ以上の Azure サブスクリプションまたは Microsoft 365 テナントがある場合は、既に Azure テナントがあります。 そうでない場合は、新しいテナントをプロビジョニングします。

  2. アプリの登録を作成します。アプリの登録により、アプリケーションとMicrosoft ID プラットフォームの間に信頼関係が確立され、アプリが認証を行い、リソースに安全にアクセスできるようになります。

    アプリを登録すると、クライアント ID、オブジェクト ID、ディレクトリ ID が作成されます。 アプリ登録の資格情報を作成するには、「アプリケーションをMicrosoft ID プラットフォームに登録する」を参照してください。

Entra IDセットアップ手順

  1. アプリの登録 - 既存のMicrosoft Entra IDアプリ登録を使用するか、作成します。 そのアプリケーション (クライアント) IDを記録します。 Azure ポータルで、Microsoft Entra ID>アプリの登録>> の下にあります。

  2. アプリの登録をバインドする - プロファイル管理に移動し、[アプリケーション (クライアント) ID] タブを選択し、[アプリケーション (クライアント) ID のバインド] を選択します。 アプリケーション (クライアント) ID を入力します。 プロファイルの更新は、同期に最大 1 分かかる場合があります。

    Note

    [アプリケーション (クライアント) ID] タブを使用できない場合は、お使いの試用版で Microsoft Entra ID 認証が有効になっていない可能性があります。 専用アクセスを要求するには、Microsoft担当者にお問い合わせください。

  3. トークンを取得する - 任意の Microsoft Authentication Library (MSAL) でクライアント資格情報フローを使用します。

    • 機関: https://login.microsoftonline.com/{your-tenant-id}
    • スコープ: https://api.microsoft.ai/.default

次に、すべての Web IQ 要求でアクセス トークンを渡します。

Authorization: Bearer <access-token>

2つ以上の AppID の呼び出し

1 つのアプリケーション (クライアント) ID を複数の Web IQ AppID にバインドできます (たとえば、Web IQ リソースまたはワークロードごとに 1 つの AppID)。 その場合は、すべての要求に APPID クエリ パラメーターを追加して、呼び出しで使用する AppID を指定します。 レート制限はその AppID に対してカウントされます。

POST https://api.microsoft.ai/v3/search/web?APPID=<your-web-iq-appid>
Authorization: Bearer <access-token>
Content-Type: application/json

APPID は、アプリケーション (クライアント) ID ではなく、 Web IQ AppID を受け取ります。 Microsoft の担当者が Web IQ AppID を提供します。

お客様のアプリケーション (クライアント) ID は に紐付けられています APPID 要求に応じて Result
One AppID AppID が見つからない、または無効です リクエストは成功します
1つのAppID 別の AppID HTTP 403 AuthUnauthorizedAppId
複数の AppID 存在しないか空 HTTP 400 AuthAppIdSelectionRequired
複数の AppID バインドされた AppID の 1 つ リクエストが成功する
複数の AppID その他の AppID HTTP 403 AuthUnauthorizedAppId
AppID なし Any HTTP 401 AuthUnauthorizedEntryId

Warning

API キーでは APPID は使用できません。 各 API キーは 1 つの AppID に属します。 APPID パラメーター (空でも) を含むキー認証要求は、HTTP 401 AuthUnauthorizedEntryIdを返します。

リクエストヘッダー

Header Value Description
x-apikey または Authorization <your-api-key> または Bearer <access-token> 認証用の API キーまたはMicrosoft Entra IDアクセス トークン
Content-Type application/json リクエストボディの形式

次のステップ

サポートとフィードバック

技術的な問題やフィードバックはWeb IQ サポートに送信してください。

  • 最終更新: