Authenticeren met Microsoft Web IQ

Er zijn twee manieren om te verifiëren en toegang te krijgen tot de Microsoft Web IQ APIs. Gebruik een API-sleutel voor de snelste start en Microsoft Entra ID voor productieworkloads.

API-sleutel

Maak een API-sleutel in de Microsoft Web IQ-portal om te verifiëren met Microsoft Web IQ API's. Geef deze door in de x-apikey header voor elke request:

x-apikey: <YOUR_API_KEY>

Warning

API-sleutels verlenen volledige toegang tot uw account. Sla ze op in een secrets manager, niet in code aan de clientzijde of versiebeheer.

Microsoft Entra ID

Gebruik Microsoft Entra ID OAuth 2.0-clientreferenties (alleen-app-token) voor verificatie met de Microsoft Web IQ API.

Note

Microsoft Entra ID is het identiteitsplatform. Een app-registratie heeft een Application (client)-id die de toepassing in uw tenant identificeert en de waarde is die u verbindt met uw Web IQ-account. Tijdens runtime wisselt uw app de referenties uit voor een Microsoft Entra-toegangstoken om met elke API-aanvraag mee te sturen.

Prerequisites

  1. Een tenant instellen: Als u uw app wilt registreren, is een Azure-tenant vereist. Een Azure-abonnement is niet vereist, maar als uw organisatie al een of meer Azure abonnementen of een Microsoft 365 organisatie heeft, hebt u al een Azure tenant. Anders richt u een nieuwe tenant in.

  2. Een app-registratie maken: Een app-registratie brengt een vertrouwensrelatie tot stand tussen uw toepassing en het Microsoft identity platform, zodat uw app zich veilig kan authenticeren en resources kan openen.

    Wanneer u uw app registreert, worden er een client-id, object-id en directory-id gemaakt. Zie Een toepassing registreren bij het Microsoft identity platform om referenties voor uw app-registratie te maken.

Entra ID installatiestappen

  1. App-registratie: gebruik een bestaande Microsoft Entra ID app-registratie of maak er een. Noteer de Application (client)-ID. Zoek deze in de Azure-portal onder Microsoft Entra ID>App-registraties>uw app>Overzicht.

  2. Koppel uw app-registratie - Ga naar Profielbeheer, selecteer het tabblad Toepassings-id's (client) en selecteer vervolgens Toepassings-id (client) koppelen. Voer uw applicatie-id (client) in. Het kan tot één minuut duren voordat profielupdates zijn gesynchroniseerd.

    Note

    Als het tabblad Application (Client) IDs niet beschikbaar is, is Microsoft Entra ID-verificatie mogelijk niet ingeschakeld voor uw proefabonnement. Neem contact op met uw Microsoft-vertegenwoordiger om speciale toegang aan te vragen.

  3. Een token verkrijgen - Gebruik de client credentials grant met de gewenste Microsoft Authentication Library (MSAL):

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

Geef vervolgens het toegangstoken door op elke Web IQ-aanvraag:

Authorization: Bearer <access-token>

Meer dan één AppID aanroepen

Eén toepassings-id (client) kan worden gebonden aan meer dan één Web IQ AppID, bijvoorbeeld één AppID per Web IQ-resource of per workload. Als dat zo is, voegt u de APPID queryparameter toe aan elke aanvraag om te kiezen welke AppID de aanroep gebruikt. Frequentielimieten tellen mee voor die AppID.

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

APPID gebruikt uw Web IQ AppID, niet uw Application (client)-ID. Uw Microsoft-contactpersoon verstrekt uw Web IQ AppID's.

Uw Application (client) ID is gebonden aan APPID op aanvraag Result
One AppID Ontbreekt, of die AppID Verzoek is geslaagd
One AppID Een andere AppID HTTP 403 AuthUnauthorizedAppId
Verschillende AppIDs Ontbreekt of leeg HTTP 400 AuthAppIdSelectionRequired
Verschillende AppIDs Een van uw gebonden AppIDs Verzoek is geslaagd
Verschillende AppIDs Elke andere AppID HTTP 403 AuthUnauthorizedAppId
Geen AppID Any HTTP 401 AuthUnauthorizedEntryId

Warning

API-sleutels accepteren geen APPID. Elke API-sleutel behoort tot één AppID. Een sleutel-geverifieerde aanvraag die de APPID parameter bevat, zelfs leeg, retourneert HTTP 401 AuthUnauthorizedEntryId.

Headers aanvragen

Header Value Description
x-apikey of Authorization <your-api-key> of Bearer <access-token> Uw API-sleutel of Microsoft Entra ID toegangstoken voor verificatie
Content-Type application/json Indeling van de requestbody

Volgende stappen 

Ondersteuning en feedback

Stuur technische problemen of feedback naar Web IQ Support.

  • Laatst bijgewerkt om