JavaScript için Azure İletişim Ortak istemci kitaplığı - sürüm 2.3.1
Bu paket, Azure İletişim Hizmeti kitaplıkları için ortak kod içerir.
Başlarken
Önkoşullar
- Bir Azure aboneliği.
- Mevcut bir İletişim Hizmetleri kaynağı. Kaynağı oluşturmanız gerekiyorsa Azure Portalı, Azure PowerShell veya Azure CLI'yı kullanabilirsiniz.
Yükleme
npm install @azure/communication-common
Tarayıcı desteği
JavaScript Paketi
Bu istemci kitaplığını tarayıcıda kullanmak için önce bir paketleyici kullanmanız gerekir. Bunun nasıl yapılacağının ayrıntıları için lütfen paketleme belgelerimize bakın.
Önemli kavramlar
CommunicationTokenCredential ve AzureCommunicationTokenCredential
, CommunicationTokenCredential
Sohbet veya Arama gibi İletişim Hizmetleri ile kullanıcının kimliğini doğrulamak için kullanılan bir arabirimdir.
, AzureCommunicationTokenCredential
söz edilen arabirimi uygulayan bir kimlik bilgisi oluşturmak için kullanışlı bir yol sunar ve yerleşik otomatik yenileme mantığından yararlanmanızı sağlar.
Senaryonuza bağlı olarak şununla başlatmak AzureCommunicationTokenCredential
isteyebilirsiniz:
- statik belirteç (tek seferlik Sohbet iletileri göndermek için kullanılan kısa süreli istemciler için uygundur) veya
- iletişim sırasında sürekli kimlik doğrulama durumu sağlayan bir geri çağırma işlevi (örneğin, uzun Arama oturumları için idealdir).
Oluşturucu aracılığıyla veya belirteç yenileyici geri çağırma yoluyla öğesine sağlanan AzureCommunicationTokenCredential
belirteçler Azure İletişim Kimliği kitaplığı kullanılarak alınabilir.
Örnekler
Statik belirteçle kimlik bilgisi oluşturma
Kısa süreli istemciler için, süresi dolduktan sonra belirteci yenilemek gerekli değildir ve AzureCommunicationTokenCredential
statik belirteçle örneği oluşturulabilir.
const tokenCredential = new AzureCommunicationTokenCredential(
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjM2MDB9.adM-ddBZZlQ1WlN3pdPBOF5G4Wh9iZpxNP_fSvpF4cWs"
);
Geri çağırma ile kimlik bilgisi oluşturma
Burada, bir kullanıcı için JWT belirteç dizesini almak için ağ isteğinde bulunan bir işlevimiz fetchTokenFromMyServerForUser
olduğunu varsayıyoruz. Kendi sunucumuzdan Bob için bir belirteç getirmek üzere kimlik bilgilerine geçiririz. Sunucumuz belirteçleri vermek için Azure İletişim Kimliği kitaplığını kullanır. İşlevin fetchTokenFromMyServerForUser
her zaman geçerli bir belirteç (gelecekte sona erme tarihi ayarlanmış olarak) döndürmesi gerekir.
const tokenCredential = new AzureCommunicationTokenCredential({
tokenRefresher: async () => fetchTokenFromMyServerForUser("bob@contoso.com"),
});
Proaktif yenileme ile kimlik bilgisi oluşturma
true ayarı refreshProactively
, belirtecin süresi dolmak üzere olduğunda işlevinizi tokenRefresher
çağırır.
const tokenCredential = new AzureCommunicationTokenCredential({
tokenRefresher: async () => fetchTokenFromMyServerForUser("bob@contoso.com"),
refreshProactively: true,
});
Proaktif yenileme ve başlangıç belirteci ile kimlik bilgisi oluşturma
Geçirme initialToken
, ilk çağrıyı tokenRefresher
atlayan isteğe bağlı bir iyileştirmedir. Önyüklemeyi uygulamanızdan sonraki belirteç yenileme döngülerinden ayırmak için bunu kullanabilirsiniz.
const tokenCredential = new AzureCommunicationTokenCredential({
tokenRefresher: async () => fetchTokenFromMyServerForUser("bob@contoso.com"),
refreshProactively: true,
token:
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjM2MDB9.adM-ddBZZlQ1WlN3pdPBOF5G4Wh9iZpxNP_fSvpF4cWs",
});
Sorun giderme
- Geçersiz belirteç belirtildi: Oluşturucuya veya
tokenRefresher
geri çağırmayaAzureCommunicationTokenCredential
geçirdiğiniz belirtecin boş bir JWT belirteç dizesi olduğundan emin olun. Örneğin, belirteci almak için Azure İletişim Kimliği kitaplığını veya REST API'yi kullanıyorsanız, yanıt nesnesinintoken
yalnızca bir bölümünü geçirdiğinizden emin olun.
Sonraki adımlar
Katkıda bulunma
Bu kitaplığa katkıda bulunmak isterseniz, kodu derleme ve test etme hakkında daha fazla bilgi edinmek için lütfen katkıda bulunma kılavuzunu okuyun.
İlgili projeler
Azure SDK for JavaScript