Uwierzytelnianie przy użyciu Microsoft Web IQ

Istnieją dwa sposoby uwierzytelniania i uzyskiwania dostępu do interfejsów API Microsoft Web IQ. Użyj klucza interfejsu API, aby uzyskać najszybszy start i Microsoft Entra ID dla obciążeń produkcyjnych.

klucz interfejsu API

Utwórz klucz interfejsu API w Microsoft Web IQ portal w celu uwierzytelnienia przy użyciu Microsoft Web IQ APIs. Przekaż go w nagłówku x-apikey w każdym żądaniu:

x-apikey: <YOUR_API_KEY>

Warning

Klucze interfejsu API zapewniają pełny dostęp do twojego konta. Przechowuj je w menedżerze sekretów, a nie w kodzie po stronie klienta lub systemie kontroli wersji.

Microsoft Entra ID

Użyj poświadczeń klienta OAuth 2.0 usługi Microsoft Entra ID (tokenu tylko aplikacji) do uwierzytelniania w Microsoft Web IQ API.

Note

Microsoft Entra ID to platforma tożsamości. Rejestracja aplikacji ma Identyfikator aplikacji (klienta), który identyfikuje aplikację w dzierżawcy i jest wartością powiązaną z kontem Web IQ. W czasie wykonywania aplikacja wymienia swoje poświadczenia na token dostępu Microsoft Entra, aby dołączać go do każdego żądania interfejsu API.

Prerequisites

  1. Skonfiguruj dzierżawcę: Aby zarejestrować aplikację, jest wymagany dzierżawca platformy Azure. Subskrypcja Azure nie jest wymagana, ale jeśli Twoja organizacja ma już co najmniej jedną subskrypcję Azure lub organizację Microsoft 365, Twoja organizacja ma już dzierżawę platformy Azure. W przeciwnym razie utwórz nową dzierżawę.

  2. Tworzenie rejestracji aplikacji: Rejestracja aplikacji ustanawia relację zaufania między aplikacją a Platforma tożsamości Microsoft, umożliwiając aplikacji bezpieczne uwierzytelnianie i uzyskiwanie dostępu do zasobów.

    Podczas rejestrowania aplikacji tworzony jest identyfikator klienta, identyfikator obiektu i identyfikator katalogu. Aby utworzyć poświadczenia dla rejestracji aplikacji, zobacz Rejestrowanie aplikacji w Platforma tożsamości Microsoft.

Entra ID kroki konfiguracji

  1. Rejestracja aplikacji — użyj istniejącej rejestracji aplikacji Microsoft Entra ID lub utwórz nową rejestrację aplikacji. Zanotuj identyfikator aplikacji (klienta). W portalu Azure znajdź go w obszarze Microsoft Entra ID>Rejestracje aplikacji>twoja aplikacja>Przegląd.

  2. Powiąż rejestrację aplikacji — przejdź do pozycji Zarządzanie profilami, wybierz kartę Identyfikatory aplikacji (klienta), a następnie wybierz pozycję Powiąż identyfikator aplikacji (klienta). Wprowadź identyfikator klienta aplikacji. Synchronizacja aktualizacji profilu może potrwać do jednej minuty.

    Note

    Jeśli karta Identyfikatory aplikacji (klienta) jest niedostępna, Microsoft Entra ID uwierzytelnianie może nie być włączone dla wersji próbnej. Skontaktuj się z przedstawicielem Microsoft, aby poprosić o dedykowany dostęp.

  3. Uzyskiwanie tokenu — użyj przepływu poświadczeń klienta z preferowaną biblioteką Microsoft Authentication Library (MSAL):

    • Autorytet: https://login.microsoftonline.com/{your-tenant-id}
    • Zakres: https://api.microsoft.ai/.default

Następnie przekaż token dostępu do każdego żądania Web IQ:

Authorization: Bearer <access-token>

Wywoływanie więcej niż jednego identyfikatora AppID

Jeden identyfikator aplikacji (klienta) może być powiązany z więcej niż jednym identyfikatorem Web IQ AppID, na przykład jednym AppID dla każdego zasobu Web IQ lub dla każdego obciążenia. Gdy tak jest, dodaj parametr zapytania APPID do każdego żądania, aby wybrać identyfikator AppID, z którego korzysta wywołanie. Limity żądań są liczone względem tego identyfikatora AppID.

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

APPID pobiera identyfikator Web IQ AppID, a nie identyfikator aplikacji (klienta). Twój kontakt w firmie Microsoft podaje identyfikatory Web IQ AppIDs.

Identyfikator aplikacji (klienta) jest powiązany z APPID na prośbę Result
Jeden AppID Brak lub ten AppID Żądanie powiodło się
Jeden AppID Inny identyfikator AppID HTTP 403 AuthUnauthorizedAppId
Kilka identyfikatorów AppID Brak lub pusty HTTP 400 AuthAppIdSelectionRequired
Kilka identyfikatorów AppID Jedno z powiązanych AppID Żądanie zakończone powodzeniem
Kilka identyfikatorów AppID Dowolny inny AppID HTTP 403 AuthUnauthorizedAppId
Brak identyfikatora aplikacji Dowolne HTTP 401 AuthUnauthorizedEntryId

Warning

Klucze interfejsu API nie przyjmują APPID. Każdy klucz interfejsu API należy do jednego identyfikatora AppID. Żądanie uwierzytelnione za pomocą klucza, które zawiera APPID parametr , nawet pusty, zwraca błąd HTTP 401 AuthUnauthorizedEntryId.

Nagłówki żądań

Header Value Description
x-apikey lub Authorization <your-api-key> lub Bearer <access-token> Klucz interfejsu API lub token dostępu Microsoft Entra ID na potrzeby uwierzytelniania
Content-Type application/json Format treści żądania

Następne kroki

Pomoc techniczna i opinie

Wysyłaj problemy techniczne lub opinie do Web IQ Support.

  • Ostatnia aktualizacja o