Microsoft Web IQ ile kimlik doğrulayın

Microsoft Web IQ API'lerinin kimliğini doğrulamanın ve erişim kazanmanın iki yolu vardır. En hızlı başlangıç için bir API anahtarı, üretim iş yükleri için Microsoft Entra ID kullanın.

API anahtarı

Microsoft Web IQ API'leriyle kimlik doğrulaması yapmak için Microsoft Web IQ portalında bir API anahtarı oluşturun. Her istekte x-apikey üst bilgide gönderin:

x-apikey: <YOUR_API_KEY>

Warning

API anahtarları hesabınıza tam erişim verir. Bunları istemci tarafı kodunda veya kaynak denetiminde değil, Secret Manager'da depolayın.

Microsoft Entra Kimliği

Microsoft Web IQ API'si ile kimlik doğrulaması için Microsoft Entra ID OAuth 2.0 İstemci Kimlik Bilgilerini (yalnızca uygulama belirteci) kullanın.

Note

Microsoft Entra ID bir kimlik platformudur. Uygulama kaydı, kiracınızdaki uygulamayı tanımlayan ve Web IQ hesabınıza bağladığınız değer olan Uygulama (istemci) kimliğine sahiptir. Çalışma zamanında uygulamanız, her API isteğiyle göndermek üzere kimlik bilgilerini bir Microsoft Entra erişim belirteciyle değiş tokuş eder.

Prerequisites

  1. Kiracı oluşturma: Uygulamanızı kaydetmek için bir Azure kiracısı gerekir. Azure aboneliği gerekli değildir, ancak kuruluşunuzun zaten bir veya daha fazla Azure aboneliği veya Microsoft 365 kuruluşu varsa, zaten bir Azure kiracısı vardır. Aksi takdirde yeni bir kiracı oluşturun.

  2. Uygulama kaydı oluşturma: Uygulama kaydı, uygulamanızla Microsoft kimlik platformu arasında bir güven ilişkisi kurarak uygulamanızın kimlik doğrulamasını ve kaynaklara güvenli bir şekilde erişmesini sağlar.

    Uygulamanızı kaydettiğinizde bir istemci kimliği, nesne kimliği ve dizin kimliği oluşturulur. Uygulama kaydınız için kimlik bilgileri oluşturmak üzere bkz. Microsoft kimlik platformunda bir uygulama kaydetme.

Entra ID kurulum adımları

  1. Uygulama kaydı - Mevcut bir Microsoft Entra ID uygulama kaydını kullanın veya bir kayıt oluşturun. Uygulama (istemci) kimliğini kaydedin. Azure portalında bunu Microsoft Entra ID>Uygulama kayıtları>uygulamanız> altında bulabilirsiniz.

  2. Uygulama kaydınızı bağlama - Profil Yönetimi'ne gidin, Uygulama (İstemci) Kimlikleri sekmesini ve ardından Uygulama (İstemci) Kimliğini Bağla'yı seçin. Uygulama (istemci) kimliğinizi girin. Profil güncelleştirmelerinin eşitlenmesi bir dakika kadar sürebilir.

    Note

    Uygulama (İstemci) Kimlikleri sekmesi kullanılamıyorsa Microsoft Entra ID kimlik doğrulaması denemeniz için etkinleştirilmemiş olabilir. Özel erişim istemek için Microsoft temsilcinize başvurun.

  3. Belirteç alma - tercih ettiğiniz Microsoft Authentication Library (MSAL) ile istemci kimlik bilgileri yetkilendirme akışını kullanın:

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

Ardından erişim belirtecini her Web IQ isteğine geçirin:

Authorization: Bearer <access-token>

Birden fazla AppID çağırma

Bir Uygulama (istemci) kimliği birden fazla Web IQ AppID'ye bağlanabilir, örneğin Web IQ kaynağı başına veya iş yükü başına bir AppID. Böyle olduğunda, çağrının hangi AppID'yi kullanacağını seçmek için her isteğe APPID sorgu parametresini ekleyin. Hız sınırları bu AppID için hesaba katılır.

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

APPID Uygulama (istemci) kimliğinizi değil Web IQ AppID'nizi alır. Microsoft irtibat kişiniz Web IQ AppID'lerinizi sağlar.

Uygulama (istemci) kimliğiniz şuna bağlıdır APPID istekte Result
Bir AppID Eksik veya o AppID İstek başarılı oldu
Bir AppID Farklı bir AppID HTTP 403 AuthUnauthorizedAppId
Birkaç uygulama kimliği Eksik veya boş HTTP 400 AuthAppIdSelectionRequired
Birkaç AppID Bağlı AppID'lerinizden biri İstek başarılı
Birkaç AppID Başka herhangi bir AppID HTTP 403 AuthUnauthorizedAppId
AppID yok Any HTTP 401 AuthUnauthorizedEntryId

Warning

API anahtarları APPID kabul etmez. Her API anahtarı bir AppID'ye aittir. Boş bile olsa APPID parametresini içeren anahtar kimliği doğrulanmış bir istek HTTP 401 AuthUnauthorizedEntryId döndürür.

İstek başlıkları

Header Value Description
x-apikey veya Authorization <your-api-key> veya Bearer <access-token> Kimlik doğrulaması için API anahtarınız veya Microsoft Entra ID erişim belirteciniz
Content-Type application/json İstek gövdesi biçimi

Sonraki Adımlar

Destek ve geri bildirim

Web IQ Desteği'ne teknik sorunlar veya geri bildirim gönderin.

  • Son güncelleştirme: