Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Es gibt zwei Möglichkeiten, sich zu authentifizieren und Zugriff auf die Microsoft Web IQ-APIs zu erhalten. Verwenden Sie einen API-Schlüssel für den schnellsten Start und Microsoft Entra ID für Produktionsworkloads.
API-Schlüssel
Erstellen Sie einen API-Schlüssel im Microsoft Web IQ-Portal, um sich bei Microsoft Web IQ-APIs zu authentifizieren. Übergeben Sie ihn in der x-apikey Kopfzeile für jede Anfrage:
x-apikey: <YOUR_API_KEY>
Warning
API-Schlüssel gewähren Vollzugriff auf Ihr Konto. Speichern Sie sie in einem Secret-Manager, nicht in clientseitigem Code oder in der Quellcodeverwaltung.
Microsoft Entra ID
Verwenden Sie Microsoft Entra ID OAuth 2.0 Client Credentials (reines App-Token) für die Authentifizierung mit der Microsoft Web IQ-API.
Note
Microsoft Entra ID ist die Identitätsplattform. Eine App-Registrierung verfügt über eine Anwendungs-ID (Client-ID), die die Anwendung in Ihrem Mandanten identifiziert und den Wert darstellt, den Sie an Ihr Web IQ-Konto binden. Zur Laufzeit tauscht Ihre App ihre Anmeldeinformationen gegen ein Microsoft Entra-Zugriffstoken aus, das mit jeder API-Anforderung gesendet werden soll.
Voraussetzungen
Einrichten eines Mandanten: Um Ihre App zu registrieren, ist ein Azure Mandant erforderlich. Ein Azure-Abonnement ist nicht erforderlich, aber wenn Ihre Organisation bereits über ein oder mehrere Azure-Abonnements oder eine Microsoft 365-Organisation verfügt, hat sie bereits einen Azure-Mandanten. Stellen Sie andernfalls einen neuen Mandanten bereit.
Erstellen einer App-Registrierung: Eine App-Registrierung stellt eine Vertrauensstellung zwischen Ihrer Anwendung und der Microsoft Identity Platform her, sodass Ihre App sich sicher authentifizieren und auf Ressourcen zugreifen kann.
Wenn Sie Ihre App registrieren, werden eine Client-ID, Objekt-ID und Verzeichnis-ID erstellt. Informationen zum Erstellen von Anmeldeinformationen für Ihre App-Registrierung finden Sie unter Eine Anwendung bei der Microsoft Identity Platform registrieren.
Entra ID Setupschritte
App-Registrierung – Verwenden Sie eine vorhandene Microsoft Entra ID App-Registrierung, oder erstellen Sie eine. Notieren Sie die Anwendungs-ID (Client). Suchen Sie im Azure-Portal unter Microsoft Entra ID>App-Registrierungen>Ihre App>Übersicht.
Binden Sie Ihre App-Registrierung – Wechseln Sie zur Profilverwaltung, wählen Sie die Registerkarte Anwendungs-IDs (Client-IDs) und dann Anwendungs-ID (Client-ID) binden aus. Geben Sie Ihre Anwendungs-ID (Client-ID) ein. Profilaktualisierungen können bis zu einer Minute dauern, bis sie synchronisiert werden.
Note
Wenn die Registerkarte Application (Client) IDs nicht verfügbar ist, ist die Microsoft Entra ID-Authentifizierung möglicherweise nicht für Ihre Testversion aktiviert. Wenden Sie sich an Ihren Microsoft Vertreter, um dedizierten Zugriff anzufordern.
Abrufen eines Tokens – Verwenden Sie den Clientanmeldeinformationsfluss mit Ihrer bevorzugten Microsoft Authentication Library (MSAL) (MSAL):
- Autorität:
https://login.microsoftonline.com/{your-tenant-id} - Geltungsbereich:
https://api.microsoft.ai/.default
- Autorität:
Übergeben Sie dann das Zugriffstoken für jede Web IQ-Anforderung:
Authorization: Bearer <access-token>
Aufrufen von mehr als einer AppID
Eine Anwendungs-ID (Client) kann an mehrere Web IQ AppID gebunden werden, z. B. eine AppID pro Web IQ-Ressource oder pro Workload. Wenn dies der Fall ist, fügen Sie den APPID Abfrageparameter jeder Anforderung hinzu, um auszuwählen, welche AppID der Aufruf verwendet. Ratenbegrenzungen werden auf diese AppID angerechnet.
POST https://api.microsoft.ai/v3/search/web?APPID=<your-web-iq-appid>
Authorization: Bearer <access-token>
Content-Type: application/json
APPID nimmt Ihre Web IQ AppID, nicht Ihre Anwendungs-ID (Client-ID). Ihr Microsoft Kontakt stellt Ihre Web IQ AppIDs bereit.
| Ihre Anwendungs-ID (Client-ID) ist gebunden an |
APPID zur Anfrage |
Result |
|---|---|---|
| One AppID | Fehlt, oder jene AppID | Anforderung erfolgreich ausgeführt |
| One AppID | Eine andere AppID | HTTP 403 AuthUnauthorizedAppId |
| Mehrere AppIDs | Fehlende oder leere | HTTP 400 AuthAppIdSelectionRequired |
| Mehrere AppIDs | Eine Ihrer gebundenen AppIDs | Anfrage erfolgreich ausgeführt |
| Mehrere AppIDs | Beliebige andere AppID | HTTP 403 AuthUnauthorizedAppId |
| Keine AppID | Any | HTTP 401 AuthUnauthorizedEntryId |
Warning
API-Schlüssel akzeptieren keine APPID. Jeder API-Schlüssel gehört zu einer AppID. Eine schlüsselauthentifizierte Anforderung, die den APPID-Parameter enthält, auch wenn er leer ist, gibt HTTP 401 AuthUnauthorizedEntryId zurück.
Anfrage-Header
| Header | Wert | Description |
|---|---|---|
x-apikey oder Authorization |
<your-api-key> oder Bearer <access-token> |
Ihr API-Schlüssel oder Microsoft Entra ID Zugriffstoken für die Authentifizierung |
Content-Type |
application/json |
Format des Anforderungstexts |
Nächste Schritte
- Führen Sie Ihren ersten API-Aufruf im Schnellstart aus.
- Erkunden Sie die REST-API-Referenz.
Support und Feedback
Senden Sie technische Probleme oder Feedback an den Web IQ Support.