Autentisera med Microsoft Web IQ

Det finns två sätt att autentisera och få åtkomst till API:erna för Microsoft Web IQ. Använd en API-nyckel för den snabbaste starten och Microsoft Entra ID för produktionsarbetsbelastningar.

API-nyckel

Skapa en API-nyckel i Microsoft Web IQ-portalen för att autentisera med Microsoft API:er för webb-IQ. Skicka det i x-apikeyheadern på varje begäran:

x-apikey: <YOUR_API_KEY>

Varning

API-nycklar ger fullständig åtkomst till ditt konto. Lagra dem i en hemlighetshanterare, inte i klientkod eller i källkontrollen.

Microsoft Entra ID

Använd Microsoft Entra ID OAuth 2.0-klientuppgifter (endast apptoken) för att autentisera med Microsoft Web IQ API.

Note

Microsoft Entra ID är identitetsplattformen. En appregistrering har ett program-ID (klient) som identifierar programmet i din klientorganisation och är värdet som du binder till ditt Web IQ-konto. Vid körningen byter appen ut sina autentiseringsuppgifter mot en Microsoft Entra åtkomsttoken som ska skickas med varje API-begäran.

Prerequisites

  1. Konfigurera en tenant: För att registrera din app krävs en Azure-tenant. En Azure prenumeration krävs inte, men om din organisation redan har en eller flera Azure prenumerationer eller en Microsoft 365 organisation har du redan en Azure-klientorganisation. Annars etablerar du en ny tenant.

  2. Skapa en appregistrering: En appregistrering upprättar en förtroenderelation mellan ditt program och Microsofts identitetsplattform, vilket gör det möjligt för appen att autentisera och komma åt resurser på ett säkert sätt.

    När du registrerar din app skapas ett klient-ID, objekt-ID och katalogens ID. Information om hur du skapar autentiseringsuppgifter för din appregistrering finns i Registrera ett program med Microsofts identitetsplattform.

Entra ID konfigurationssteg

  1. Appregistrering – Använd en befintlig Microsoft Entra ID appregistrering eller skapa en. Anteckna dess program-ID (klient-ID). I Azure-portalen hittar du den under Microsoft Entra ID>App registrations>din app>.

  2. Bind appregistreringen – Gå till Profilhantering, välj fliken Program-ID:n (klient) och välj sedan Bind program-ID (klient). Ange ditt applikations-ID (klient-)ID. Det kan ta upp till en minut att synkronisera profiluppdateringar.

    Note

    Om fliken Program-ID:n (klient) inte är tillgänglig kanske Microsoft Entra ID-autentisering inte är aktiverad för utvärderingsversionen. Kontakta din Microsoft representant för att begära dedikerad åtkomst.

  3. Hämta en token – Använd beviljandet client credentials med önskad Microsofts autentiseringsbibliotek (MSAL):

    • Auktoritet: https://login.microsoftonline.com/{your-tenant-id}
    • Omfång: https://api.microsoft.ai/.default

Skicka sedan med åtkomsttoken i varje Web IQ-begäran:

Authorization: Bearer <access-token>

Anropa mer än ett AppID

Ett applikations-ID (klient) kan bindas till mer än ett Webb-IQ AppID, till exempel ett AppID per webb-IQ-resurs eller per arbetsbelastning. När så är fallet lägger du till APPID frågeparametern i varje begäran för att välja vilket AppID anropet använder. Frekvensgränser belastar det AppID:t.

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

APPID tar ditt Web IQ AppID, inte ditt program-ID (klient)-ID. Din Microsoft kontakt tillhandahåller dina Web IQ AppIDs.

Ditt applikations-ID (klient) är bundet till APPID på begäran Result
Ett AppID Saknas, eller AppID Begäran lyckades
Ett AppID Ett annat AppID HTTP 403 AuthUnauthorizedAppId
Flera App-ID:ar Saknas eller är tom HTTP 400 AuthAppIdSelectionRequired
Flera App-ID:ar Ett av dina bundna App-ID:er Begäran lyckades
Flera App-ID:ar Något annat AppID HTTP 403 AuthUnauthorizedAppId
Inget AppID Vilken som helst HTTP 401 AuthUnauthorizedEntryId

Varning

API-nycklar accepterar inte APPID. Varje API-nyckel tillhör ett AppID. En nyckelautentiserad begäran som innehåller parametern APPID , även tom, returnerar HTTP 401 AuthUnauthorizedEntryId.

Förfrågningsrubriker

Header Value Description
x-apikey eller Authorization <your-api-key> eller Bearer <access-token> Din API-nyckel eller Microsoft Entra ID åtkomsttoken för autentisering
Content-Type application/json Format för begärandetexten

Nästa steg

Support och feedback

Skicka tekniska frågor eller feedback till Web IQ Support.

  • Uppdaterades senast