Выполните проверку подлинности с помощью Microsoft Web IQ

Существует два способа проверки подлинности и получения доступа к API Microsoft Web IQ. Используйте ключ API для самого быстрого запуска и Microsoft Entra ID для производственных сред.

Ключ API

Создайте ключ API в портале Microsoft Web IQ для аутентификации с API Microsoft Web IQ. Передайте его в заголовке x-apikey для каждого запроса:

x-apikey: <YOUR_API_KEY>

Предупреждение

Ключи API предоставляют полный доступ к вашей учетной записи. Храните их в диспетчере секретов, а не в клиентском коде или системе управления версиями.

Майкрософт Ентра айди

Используйте поток Client Credentials OAuth 2.0 Microsoft Entra ID (токен только для приложения) для проверки подлинности с помощью Microsoft Web IQ API.

Note

Microsoft Entra ID — это платформа идентификации. Регистрация приложения имеет идентификатор приложения (клиента), который определяет приложение в вашем тенанте и является значением, которое вы привязываете к своей учетной записи Web IQ. Во время выполнения приложение обменивает свои учетные данные на маркер доступа Microsoft Entra, который приложение отправляет с каждым запросом API.

Prerequisites

  1. Настройка тенанта: Чтобы зарегистрировать приложение, требуется тенант Azure. Подписка Azure не требуется, но если у вашей организации уже есть одна или несколько подписок Azure или организация Microsoft 365, то у вас уже есть тенант Azure. В противном случае подготовьте нового арендатора.

  2. Создайте регистрацию приложения: Регистрация приложения устанавливает отношение доверия между приложением и платформой удостоверений Майкрософт, что позволяет приложению безопасно проходить проверку подлинности и получать доступ к ресурсам.

    При регистрации приложения создаются идентификатор клиента, идентификатор объекта и идентификатор каталога. Сведения о создании учетных данных для регистрации приложения см. Регистрация приложения на платформе платформа удостоверений Майкрософт.

действия по настройке Entra ID

  1. Регистрация приложения — используйте существующую регистрацию приложения Microsoft Entra ID или создайте ее. Запишите идентификатор приложения (клиента). На портале Azure найдите его в разделе Microsoft Entra ID>Регистрация приложений>ваше приложение>Обзор.

  2. Привяжите регистрацию приложения — перейдите к Управление профилями, перейдите на вкладку Идентификаторы приложений (клиента), а затем выберите Привязать идентификатор приложения (клиента). Введите идентификатор приложения (клиента). Обновления профиля могут синхронизироваться до одной минуты.

    Note

    Если вкладка Application (Client) IDs недоступна, проверка подлинности Microsoft Entra ID может быть не включена для пробной версии. Обратитесь к представителю Microsoft, чтобы запросить выделенный доступ.

  3. Получить токен — используйте поток client credentials с помощью предпочитаемой библиотеки Microsoft Authentication Library (MSAL):

    • Орган надзора: https://login.microsoftonline.com/{your-tenant-id}
    • Область: https://api.microsoft.ai/.default

Затем передайте маркер доступа в каждом запросе Web IQ:

Authorization: Bearer <access-token>

Использование нескольких AppID

Один идентификатор приложения (клиента) может быть привязан к нескольким Web IQ AppID, например одному идентификатору AppID на ресурс веб-IQ или на рабочую нагрузку. При этом добавьте параметр запроса APPID к каждому запросу, чтобы выбрать, какой идентификатор приложения использует вызов. Ограничения по скорости применяются к этому AppID.

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

APPID принимает ваш Web IQ AppID, а не идентификатор приложения (клиента). Ваш контакт в Microsoft предоставляет идентификаторы веб-IQ AppID.

Идентификатор приложения (клиента) привязан к APPID по запросу Result
Один AppID Отсутствует или тот AppID Запрос успешно выполняется
Один AppID Другой AppID HTTP 403 AuthUnauthorizedAppId
Несколько идентификаторов приложений Отсутствует или пусто HTTP 400 AuthAppIdSelectionRequired
Несколько идентификаторов приложений Один из ваших привязанных AppID Запрос успешно выполнен
Несколько идентификаторов приложений Любой другой идентификатор AppID HTTP 403 AuthUnauthorizedAppId
AppID отсутствует Любое HTTP 401 AuthUnauthorizedEntryId

Предупреждение

Ключи API не используют APPID. Каждый ключ API принадлежит одному идентификатору 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.

  • Последнее обновление: