Autenticarse con Microsoft Web IQ

Hay dos maneras de autenticarse y obtener acceso a las API de MICROSOFT Web IQ. Use una clave de API para el inicio más rápido y Microsoft Entra ID para cargas de trabajo de producción.

Clave de API

Cree una clave de API en el portal de Microsoft Web IQ para autenticarse con las API de Microsoft Web IQ. Páselo en el x-apikey encabezado en cada solicitud:

x-apikey: <YOUR_API_KEY>

Warning

Las claves de API conceden acceso completo a su cuenta. Almacénelos en un administrador de secretos, no en el código del lado cliente ni en el control de código fuente.

Microsoft Entra ID

Utilice las credenciales de cliente de OAuth 2.0 de Microsoft Entra ID (token de solo aplicación) para autenticarse con la API web IQ de Microsoft.

Note

Microsoft Entra ID es la plataforma de identidad. Un registro de aplicación tiene un Id. de aplicación (cliente), que identifica la aplicación en su tenant y es el valor que vincula a su cuenta de Web IQ. En tiempo de ejecución, la aplicación intercambia sus credenciales por un token de acceso de Microsoft Entra para enviarlo con cada solicitud de API.

Prerequisites

  1. Configuración de un tenant: Para registrar su aplicación, se requiere un tenant de Azure. No se requiere una suscripción Azure, pero si su organización ya tiene una o varias suscripciones de Azure o una organización de Microsoft 365, ya tiene un tenant de Azure. De lo contrario, configure un nuevo tenant.

  2. Cree un registro de aplicación: Un registro de aplicación establece una relación de confianza entre la aplicación y la plataforma de identidad de Microsoft, lo que permite a la aplicación autenticarse y acceder a los recursos de forma segura.

    Al registrar la aplicación, se crea un identificador de cliente, un identificador de objeto y un identificador de directorio. Para crear credenciales para el registro de su aplicación, consulte Registrar una aplicación con la plataforma de identidad de Microsoft.

pasos de configuración de Entra ID

  1. Registro de aplicaciones - Use un registro de aplicación de Microsoft Entra ID existente o cree uno. Registre el identificador de aplicación (cliente). En el portal de Azure, búsquelo en Microsoft Entra ID>Registros de aplicaciones>su aplicación>.

  2. Enlazar el registro de la aplicación: vaya a Administración de perfiles, seleccione la pestaña Identificadores de aplicación (cliente) y, a continuación, seleccione Enlazar el identificador de aplicación (cliente). Escriba el ID de cliente de la aplicación. Las actualizaciones de perfil pueden tardar hasta un minuto en sincronizarse.

    Note

    Si la pestaña Identificadores de aplicación (cliente) no está disponible, es posible que la autenticación de Microsoft Entra ID no esté habilitada para la versión de prueba. Póngase en contacto con su representante de Microsoft para solicitar acceso dedicado.

  3. Obtener un token: use la concesión de credenciales de cliente con su Biblioteca de autenticación de Microsoft preferida (MSAL):

    • Autoridad: https://login.microsoftonline.com/{your-tenant-id}
    • Ámbito: https://api.microsoft.ai/.default

A continuación, pase el token de acceso en cada solicitud de Web IQ:

Authorization: Bearer <access-token>

Llamar a más de un AppID

Un identificador de aplicación (cliente) se puede enlazar a más de un AppID de Web IQ, por ejemplo, un AppID por recurso de Web IQ o por carga de trabajo. Cuando sea así, agregue el APPID parámetro de consulta a cada solicitud para elegir qué AppID usa la llamada. Los límites de tasa se contabilizan para ese AppID.

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

APPID usa tu Web IQ AppID, no el identificador de la aplicación (cliente). El contacto de Microsoft le proporcionará sus AppIDs de Web IQ.

El ID. de aplicación (cliente) está enlazado a APPID en la solicitud Result
One AppID Falta o ese AppID La solicitud se completa correctamente
AppID Un AppID diferente HTTP 403 AuthUnauthorizedAppId
Varios AppIDs Ausente o vacío HTTP 400 AuthAppIdSelectionRequired
Varios AppIDs Uno de tus AppIDs enlazados La solicitud se realiza con éxito
Varios AppIDs Cualquier otro AppID HTTP 403 AuthUnauthorizedAppId
Sin AppID Any HTTP 401 AuthUnauthorizedEntryId

Warning

Las claves de API no aceptan APPID. Cada clave de API pertenece a un AppID. Una solicitud autenticada por clave que incluye el APPID parámetro, incluso vacío, devuelve HTTP 401 AuthUnauthorizedEntryId.

Cabeceras de solicitud

Header Value Description
x-apikey o Authorization <your-api-key> o Bearer <access-token> La clave de API o el token de acceso de Microsoft Entra ID para la autenticación
Content-Type application/json Formato del cuerpo de la solicitud

Pasos siguientes

Soporte y comentarios

Envíe problemas técnicos o comentarios al soporte técnico de Web IQ.

  • Se actualizó por última vez el