Hitelesítés a Microsoft Web IQ használatával

Kétféleképpen lehet hitelesíteni és hozzáférni a Microsoft webes IQ API-khoz. Használjon API-kulcsot a leggyorsabb kezdéshez és a Microsoft Entra ID-t éles munkaterhelésekhez.

API-kulcs

Hozzon létre egy API-kulcsot a Microsoft Web IQ portalon Microsoft Web IQ API-kkal való hitelesítéshez. Minden kérés fejlécében x-apikey adja át:

x-apikey: <YOUR_API_KEY>

Warning

Az API-kulcsok teljes hozzáférést biztosítanak a fiókjához. Tárolja őket titokkezelőben, nem ügyféloldali kódban vagy forrásvezérlőben.

Microsoft Entra ID

Használja a Microsoft Entra ID OAuth 2.0 ügyfél-azonosító hitelesítő adatait (csak alkalmazásos token) a Microsoft Web IQ API-val való hitelesítéshez.

Note

A Microsoft Entra ID az identitásplatform. Az alkalmazásregisztráció rendelkezik egy Alkalmazás- (ügyfél-) azonosítóval, amely azonosítja az alkalmazást a bérlőben, és az az érték, amelyet a Web IQ-fiókhoz köt. Futtatókörnyezetben az alkalmazás a hitelesítő adatait egy Microsoft Entra hozzáférési jogkivonatra cseréli, hogy minden API-kéréssel elküldhesse azt.

Prerequisites

  1. Bérlő beállítása: Az alkalmazás regisztrálásához Azure bérlőre van szükség. Nincs szükség Azure előfizetésre, de ha szervezete már rendelkezik egy vagy több Azure előfizetéssel vagy Microsoft 365 szervezettel, akkor már rendelkezik Azure bérlővel. Ellenkező esetben helyezzen üzembe egy új bérlői környezetet.

  2. Alkalmazásregisztráció létrehozása: Az alkalmazásregisztráció megbízhatósági kapcsolatot létesít az alkalmazás és a Microsoft Identity Platform között, így az alkalmazás biztonságosan hitelesítheti és elérheti az erőforrásokat.

    Az alkalmazás regisztrálásakor létrejön egy ügyfélazonosító, egy objektumazonosító és egy könyvtárazonosító. Az alkalmazásregisztráció hitelesítő adatainak létrehozásához lásd: Alkalmazás regisztrálása a Microsoft Identity Platformmal.

Entra ID beállítási lépései

  1. Alkalmazásregisztráció – Használjon meglévő Microsoft Entra ID alkalmazásregisztrációt, vagy hozzon létre egyet. Rögzítse az alkalmazás (ügyfél) azonosítóját. Az Azure portálon keresse meg a Microsoft Entra ID>Alkalmazásregisztrációk>az alkalmazása>áttekintésében.

  2. Alkalmazásregisztráció társítása – Lépjen a Profilkezelés lapra, válassza az Alkalmazás (ügyfél) azonosítók lapot, majd válassza a Alkalmazás (ügyfél)azonosító társítása. Adja meg az alkalmazás (ügyfél) azonosítóját. A profilfrissítések szinkronizálása akár egy percet is igénybe vehet.

    Note

    Ha az Alkalmazás (ügyfél) azonosítók lap nem érhető el, előfordulhat, hogy Microsoft Entra ID hitelesítés nincs engedélyezve a próbaverzióhoz. Ha dedikált hozzáférést szeretne kérni, forduljon Microsoft képviselőjéhez.

  3. Token beszerzése – Használja az ügyfél-hitelesítő adatok engedélyezési folyamatát az előnyben részesített Microsoft Authentication Library (MSAL) használatával:

    • Hatóság: https://login.microsoftonline.com/{your-tenant-id}
    • Hatókör: https://api.microsoft.ai/.default

Ezután adja át a hozzáférési tokent minden Web IQ-kérésen:

Authorization: Bearer <access-token>

Több AppID meghívása

Egy alkalmazás (ügyfél)azonosító ID több Web IQ AppID-hez is köthető, például egy AppID Web IQ-erőforrásonként vagy számítási feladatonként. Ha igen, adja hozzá a APPID lekérdezési paramétert minden kéréshez, hogy kiválassza a hívás által használt AppID azonosítót. A sebességkorlátok beleszámítanak az adott AppID-hez.

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

APPID A web IQ AppID-t használja, nem az alkalmazás (ügyfél) azonosítóját. A Microsoft-kapcsolattartója biztosítja a webes IQ AppID-ket.

Az alkalmazás (ügyfél) azonosítója ehhez van kötve. APPID a kérelemhez kapcsolódóan Result
Egy AppID Hiányzik, vagy AppID A kérés sikerrel jár
Egy AppID Egy másik AppID HTTP 403 AuthUnauthorizedAppId
Több AppID-k Hiányzó vagy üres HTTP 400 AuthAppIdSelectionRequired
Több AppID Az egyik társított AppID-k közül A kérés sikerül
Több AppID Bármely más AppID HTTP 403 AuthUnauthorizedAppId
Nincs AppID Bármely HTTP 401 AuthUnauthorizedEntryId

Warning

Az API-kulcsok nem fogadnak el APPID. Minden API-kulcs egy AppID-hez tartozik. Egy kulcs által hitelesített kérelem, amely a APPID paramétert is tartalmazza, még akkor is, ha üres, HTTP 401-et AuthUnauthorizedEntryId ad vissza.

HTTP-kérés fejlécek

Header Value Description
x-apikey vagy Authorization <your-api-key> vagy Bearer <access-token> Az API-kulcs vagy Microsoft Entra ID hozzáférési token hitelesítéshez
Content-Type application/json Kéréstörzs formátuma

További lépések

Támogatás és visszajelzés

Technikai problémák vagy visszajelzés küldése a Web IQ Support részére.

  • Utolsó frissítés időpontja: