S’authentifier avec Microsoft Web IQ

Il existe deux façons de s’authentifier et d’accéder aux API Web IQ Microsoft. Utilisez une clé API pour le démarrage le plus rapide et Microsoft Entra ID pour les charges de travail de production.

Clé API

Créez une clé API dans le portail Microsoft Web IQ pour vous authentifier avec les API Microsoft Web IQ. Transmettez-le dans l’en-tête x-apikey à chaque requête :

x-apikey: <YOUR_API_KEY>

Warning

Les clés API accordent un accès complet à votre compte. Stockez-les dans un gestionnaire de secrets, et non dans le code côté client ou le contrôle de code source.

Microsoft Entra ID

Utilisez les informations d’identification client OAuth 2.0 de Microsoft Entra ID (jeton d’application uniquement) pour l’authentification avec l’API Web IQ Microsoft.

Note

Microsoft Entra ID est la plateforme d’identité. Une inscription d’application a un ID d’application (client), qui identifie l’application dans votre tenant et est la valeur que vous liez à votre compte Web IQ. Au moment de l’exécution, votre application échange ses informations d’identification contre un jeton d’accès Microsoft Entra à envoyer avec chaque demande d’API.

Prerequisites

  1. Configurer un tenant : Pour inscrire votre application, un tenant Azure est requis. Un abonnement Azure n'est pas obligatoire, mais si votre organisation a déjà un ou plusieurs abonnements Azure ou une organisation Microsoft 365, vous disposez déjà d'un tenant Azure. Sinon, provisionnez un nouveau tenant.

  2. Créez une inscription d’application : Une inscription d’application établit une relation de confiance entre votre application et la plateforme d’identités Microsoft, ce qui permet à votre application de s’authentifier et d’accéder en toute sécurité aux ressources.

    Lorsque vous inscrivez votre application, un ID client, un ID d’objet et un ID de répertoire sont créés. Pour créer des informations d’identification pour l’inscription de votre application, consultez Inscrire une application avec Plateforme d'identités Microsoft.

étapes de configuration Entra ID

  1. Enregistrement d’application - utilisez un enregistrement d’application Microsoft Entra ID existant ou créez-en un. Enregistrez son ID d’application (client). Dans le portail Azure, recherchez-le sous Microsoft Entra ID>inscriptions d'applications>>.

  2. Lier votre enregistrement de l’application - Accédez à Gestion des profils, sélectionnez l’onglet ID d’application (client), puis sélectionnez Lier l’ID d’application (client). Entrez l’ID de votre application (client). La synchronisation des mises à jour de profil peut prendre jusqu’à une minute.

    Note

    Si l'onglet ID d'application (client) n'est pas disponible, l'authentification Microsoft Entra ID peut ne pas être activée pour votre version d’essai. Contactez votre représentant Microsoft pour demander l’accès dédié.

  3. Acquérir un jeton - Utilisez le flux d’informations d’identification du client avec la bibliothèque Microsoft Authentication Library (MSAL) de votre choix :

    • Autorité : https://login.microsoftonline.com/{your-tenant-id}
    • Étendue : https://api.microsoft.ai/.default

Ensuite, transmettez le jeton d’accès avec chaque requête Web IQ :

Authorization: Bearer <access-token>

Appel de plusieurs AppID

Un ID d’application (client) peut être lié à plusieurs APPID Web IQ, par exemple un AppID par ressource Web IQ ou par charge de travail. Quand c’est le cas, ajoutez le APPID paramètre de requête à chaque requête pour choisir l’AppID que l’appel utilise. Les limites de débit sont décomptées du quota de cet AppID.

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

APPID prend votre ID d’application Web IQ, et non votre ID d’application (client). Votre contact Microsoft fournit vos AppIDs Web IQ.

Votre ID d’application (client) est lié à APPID sur la requête Result
Un AppID Manquant ou AppID manquant Requête réussie
One AppID Un autre AppID HTTP 403 AuthUnauthorizedAppId
Plusieurs AppID Manquant ou vide HTTP 400 AuthAppIdSelectionRequired
Plusieurs AppID Un de vos AppIDs associés Requête réussie
Plusieurs AppIDs Toute autre AppID HTTP 403 AuthUnauthorizedAppId
Aucun AppID N'importe lequel HTTP 401 AuthUnauthorizedEntryId

Warning

Les clés API ne prennent pas en charge APPID. Chaque clé API appartient à un AppID. Une requête authentifiée par clé qui inclut le APPID paramètre, même vide, retourne HTTP 401 AuthUnauthorizedEntryId.

En-têtes de requête

Header Value Description
x-apikey ou Authorization <your-api-key> ou Bearer <access-token> Votre clé API ou votre jeton d’accès Microsoft Entra ID pour l’authentification
Content-Type application/json Format du corps de la demande

Étapes suivantes

Assistance et commentaires

Envoyez des problèmes techniques ou des commentaires au support Web IQ.

  • Dernière mise à jour :