Ověřte pomocí Microsoft Web IQ

Existují dva způsoby ověřování a získání přístupu k rozhraním API Microsoft Web IQ. Klíč rozhraní API použijte pro nejrychlejší spuštění a Microsoft Entra ID pro produkční úlohy.

klíč rozhraní API

Na portálu Microsoft Web IQ vytvořte klíč rozhraní API pro ověřování pomocí rozhraní API Microsoft Web IQ. Předejte ji v x-apikey hlavičce každého požadavku:

x-apikey: <YOUR_API_KEY>

Warning

Klíče rozhraní API udělují úplný přístup k vašemu účtu. Ukládejte je ve správci tajných údajů, ne v kódu na straně klienta nebo ve správě zdrojového kódu.

Microsoft Entra ID

K ověřování pomocí rozhraní Microsoft Web IQ API použijte přihlašovací údaje klienta Microsoft Entra ID OAuth 2.0 (token pouze pro aplikaci).

Note

Microsoft Entra ID je platforma identit. Registrace aplikace má ID aplikace (klient), které identifikuje aplikaci ve vašem tenantovi a je hodnotou, kterou svážete s účtem webového IQ. Aplikace za běhu vymění své přihlašovací údaje za přístupový token Microsoft Entra, který se má odeslat s každou žádostí rozhraní API.

Prerequisites

  1. Nastavte klienta: K registraci aplikace je vyžadován klient Azure. Předplatné Azure se nevyžaduje, ale pokud už vaše organizace má jedno nebo více Azure předplatných nebo Microsoft 365 organizaci, pak už máte tenanta Azure. V opačném případě zřiďte nového klienta.

  2. Vytvoření registrace aplikace: Registrace aplikace vytvoří vztah důvěryhodnosti mezi vaší aplikací a platformou Microsoft identity platform a umožní aplikaci bezpečně ověřovat a přistupovat k prostředkům.

    Při registraci aplikace se vytvoří ID klienta, ID objektu a ID adresáře. Pokud chcete vytvořit přihlašovací údaje pro registraci vaší aplikace, přečtěte si téma Registrace aplikace pomocí Microsoft identity platform.

kroky nastavení Entra ID

  1. Registrace aplikace – Použijte existující Microsoft Entra ID registraci aplikace nebo ji vytvořte. Poznamenejte si ID aplikace (klienta). Na portálu Azure ji najdete v části Microsoft Entra ID>Registrace aplikací>vaše aplikace>Přehled.

  2. Propojte registraci aplikace – Přejděte do správy profilů, vyberte kartu ID aplikací (klienta) a pak vyberte Propojit ID aplikace (klienta). Zadejte ID klientské aplikace. Synchronizace aktualizací profilu může trvat až jednu minutu.

    Note

    Pokud karta Application (Client) IDs není dostupná, ověřování Microsoft Entra ID nemusí být pro vaši zkušební verzi povolené. Obraťte se na svého zástupce společnosti Microsoft a požádejte o vyhrazený přístup.

  3. Získání tokenu – Použijte udělení přihlašovacích údajů klienta s preferovanou knihovnou Identity a ověřování Microsoftu (MSAL):

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

Pak předejte přístupový token u každého požadavku Web IQ:

Authorization: Bearer <access-token>

Použití více než jednoho AppID

Jedno ID aplikace (klienta) může být vázáno na více než jedno Web IQ AppID, například jedno AppID pro každý prostředek Web IQ nebo pro každou úlohu. Když tomu tak je, přidejte parametr dotazu APPID do každého požadavku, abyste zvolili, které ID aplikace volání používá. Limity počtu požadavků se počítají pro toto ID aplikace.

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

APPID vezme vaše Web IQ AppID, nikoli ID vaší aplikace (klienta). Váš kontakt ve společnosti Microsoft poskytuje identifikátory WEB IQ AppID.

VAŠE ID aplikace (klienta) je vázáno na APPID na požadavku Result
One AppID Chybí nebo toto AppID Požadavek byl úspěšný.
One AppID Jiné AppID HTTP 403 AuthUnauthorizedAppId
Několik identifikátorů AppID Chybí nebo prázdné. HTTP 400 AuthAppIdSelectionRequired
Několik AppIDs Jedno z vašich vázaných AppIDs Požadavek byl úspěšný.
Několik AppIDs Jakékoli jiné AppID HTTP 403 AuthUnauthorizedAppId
Bez AppID Any HTTP 401 AuthUnauthorizedEntryId

Warning

Klíče rozhraní API nepřijímají APPID. Každý klíč rozhraní API patří k jednomu AppID. Požadavek ověřený klíčem, který obsahuje APPID parametr, i prázdný, vrátí http 401 AuthUnauthorizedEntryId.

Záhlaví žádosti

Header Value Description
x-apikey nebo Authorization <your-api-key> nebo Bearer <access-token> Váš klíč rozhraní API nebo přístupový token Microsoft Entra ID pro ověřování
Content-Type application/json Formát těla požadavku

Další kroky

Podpora a zpětná vazba

Pošlete technické problémy nebo zpětnou vazbu na Web IQ Support.

  • Poslední aktualizace v