Yeni geliştirici portalına geçiş

  • Makale

Bu makalede, kullanım dışı bırakılan eski portaldan API Management'deki yeni geliştirici portalına geçiş yapmak için uygulamanız gereken adımlar açıklanmaktadır.

Önemli

Eski geliştirici portalı artık kullanım dışı bırakılmıştır ve yalnızca güvenlik güncelleştirmelerini alır. Kullanımdan kaldırılacağı ve tüm API Management hizmetlerinden kaldırılacağı Ekim 2023'e kadar her zamanki gibi kullanmaya devam edebilirsiniz.

geliştirici portalını API Management

Kullanılabilirlik

Önemli

Bu özellik, API Management'ın Premium,Standart, Temel ve Geliştirici katmanlarında mevcuttur.

v2 katmanlarında (önizleme) özellik kullanılabilirliği için bkz. v2 katmanlarına genel bakış.

Yeni geliştirici portalındaki geliştirmeler

Yeni geliştirici portalı, kullanım dışı bırakılan portalın birçok sınırlamasını ele alır. İçeriği düzenlemek için görsel bir sürükle bırak düzenleyicisine ve tasarımcıların web sitesine stil eklemesi için özel bir panele sahiptir. Sayfalar, özelleştirmeler ve yapılandırma, portal dağıtımlarını otomatikleştirmenizi sağlayan API Management hizmetinizdeki Azure Resource Manager kaynakları olarak kaydedilir. Son olarak portalın kod tabanı açık kaynak olduğundan, özel işlevlerle genişletebilirsiniz.

Yeni geliştirici portalına geçiş

Yeni geliştirici portalı kullanım dışı portalla uyumsuzdur ve otomatik geçiş mümkün değildir. İçeriği (sayfalar, metin, medya dosyaları) el ile yeniden oluşturmanız ve yeni portalın görünümünü özelleştirmeniz gerekir. Tam adımlar, portalınızın özelleştirmelerine ve karmaşıklığına bağlı olarak değişir. Yönergeler için geliştirici portalı öğreticisine bakın. API'lerin, ürünlerin, kullanıcıların, kimlik sağlayıcılarının listesi gibi kalan yapılandırma her iki portalda da otomatik olarak paylaşılır.

Önemli

Yeni geliştirici portalını daha önce başlattıysanız ancak herhangi bir değişiklik yapmadıysanız, en son sürüme güncelleştirmek için varsayılan içeriği sıfırlayın.

Kullanım dışı portaldan geçiş yaparken aşağıdaki değişiklikleri göz önünde bulundurun:

  • Geliştirici portalınızı özel bir etki alanı aracılığıyla kullanıma sunarsanız, yeni geliştirici portalına bir etki alanı atayın . Azure portal açılan listesinden Geliştirici portalı seçeneğini kullanın.

  • Etkileşimli test konsolunu etkinleştirmek için API'lerinize bir CORS ilkesi uygulayın.

  • Portalı şekillendirmek için özel CSS eklerseniz, yerleşik tasarım panelini kullanarak stili çoğaltmanız gerekir. Yeni portalda CSS eklemeye izin verilmez.

  • Özel JavaScript'i yalnızca yeni portalın şirket içinde barındırılan sürümüne ekleyebilirsiniz.

  • API Management bir sanal ağdaysa ve Application Gateway aracılığıyla İnternet'e açıksa, kesin yapılandırma adımları için bu belge makalesine bakın. Yapmanız gerekenler:

    • API Management yönetim uç noktasına bağlantıyı etkinleştirin.
    • Yeni portal uç noktasına bağlantıyı etkinleştirin.
    • Seçili Web Uygulaması Güvenlik Duvarı kurallarını devre dışı bırakın.

  • Varsayılan e-posta bildirim şablonlarını açıkça tanımlanmış kullanım dışı portal URL'sini içerecek şekilde değiştirdiyseniz, bunları portal URL'si parametresini kullanacak veya yeni portal URL'sine işaret eden şekilde değiştirin. Şablonlar bunun yerine yerleşik portal URL'si parametresini kullanıyorsa hiçbir değişiklik gerekmez.

  • Sorunlar ve Uygulamalar yeni geliştirici portalında desteklenmez.

  • Kimlik sağlayıcıları olarak Facebook, Microsoft, Twitter ve Google ile doğrudan tümleştirme yeni geliştirici portalında desteklenmez. Bu sağlayıcılarla Azure AD B2C aracılığıyla tümleştirebilirsiniz.

  • Temsilci seçmeyi kullanıyorsanız, uygulamalarınızda dönüş URL'sini değiştirin ve SSO URL'si oluşturuç noktası yerine Paylaşılan Erişim Belirteci Api'sini Al uç noktasını kullanın.

  • Kimlik sağlayıcısı olarak Microsoft Entra kimliği kullanıyorsanız:

    • Uygulamanızdaki dönüş URL'sini yeni geliştirici portalı etki alanına işaret eden şekilde değiştirin.
    • Uygulamanızdaki dönüş URL'sinin son ekini olarak /signin-aad/signindeğiştirin.

  • Kimlik sağlayıcısı olarak Azure AD B2C kullanıyorsanız:

    • Uygulamanızdaki dönüş URL'sini yeni geliştirici portalı etki alanına işaret eden şekilde değiştirin.
    • Uygulamanızdaki dönüş URL'sinin son ekini olarak /signin-aad/signindeğiştirin.
    • Uygulama taleplerine Verilen Ad, Soyadı ve Kullanıcının Nesne Kimliğini ekleyin.

  • Etkileşimli test konsolunda OAuth 2.0 kullanıyorsanız, uygulamanızdaki dönüş URL'sini yeni geliştirici portalı etki alanına işaret etmek için değiştirin ve son eki değiştirin:

    • Yetkilendirme kodu verme akışı için kimden'e /docs/services/[serverName]/console/oauth2/authorizationcode/callback/signin-oauth/code/callback/[serverName] .
    • Örtük verme akışı için kimden'e /docs/services/[serverName]/console/oauth2/implicit/callback/signin-oauth/implicit/callback .

  • Etkileşimli test konsolunda OpenID Connect kullanıyorsanız, uygulamanızdaki dönüş URL'sini yeni geliştirici portalı etki alanını gösterecek şekilde değiştirin ve son eki değiştirin:

    • Yetkilendirme kodu verme akışı için kimden'e /docs/services/[serverName]/console/openidconnect/authorizationcode/callback/signin-oauth/code/callback/[serverName] .
    • Örtük verme akışı için kimden'e /docs/services/[serverName]/console/openidconnect/implicit/callback/signin-oauth/implicit/callback .

Sonraki adımlar

Geliştirici portalı hakkında daha fazla bilgi edinin: