API Management geliştirici portalı - sık sorulan sorular
ŞUNLAR IÇIN GEÇERLIDIR: Geliştirici | Temel | Temel v2 | Standart | Standart v2 | Premium
Portalda desteklenmeyen işlevlere ihtiyacım olursa ne olur?
Aşağıdaki seçenekler mevcuttur:
Küçük özelleştirmeler için, özel HTML eklemek için yerleşik bir pencere öğesi kullanın. Şu anda özel HTML kodu pencere öğesi API Management'ın v2 katmanlarında kullanılamaz.
Daha büyük özelleştirmeler için özel bir pencere öğesi oluşturun ve yönetilen geliştirici portalına yükleyin . Şu anda özel pencere öğeleri API Management'ın v2 katmanlarında kullanılamaz.
Geliştirici portalının kendi kendine barındırılabilmesi için geliştirici portalı kod tabanının çekirdeğinde değişiklik yapmanız gerekir.
GitHub deposunda bir özellik isteği açın.
Geliştirici portalının işlevselliğini özelleştirme ve genişletme hakkında daha fazla bilgi edinin.
Bir API Management hizmetinde birden çok geliştirici portalım olabilir mi?
Bir yönetilen portalınız ve şirket içinde barındırılan birden çok portalınız olabilir. Tüm portalların içeriği aynı API Management hizmetinde depolandığından aynı olacaktır. Portalların görünümünü ve işlevselliğini ayırt etmek istiyorsanız, çalışma zamanında sayfaları dinamik olarak özelleştiren kendi özel pencere öğelerinizle (örneğin, URL'yi temel alarak) bunları kendi kendine barındırabilirsiniz.
Portal Azure Resource Manager şablonlarını destekliyor mu ve/veya API Management DevOps Resource Kit ile uyumlu mu?
Hayır
Portalın içeriği API Management'taki yedekleme/geri yükleme işleviyle mi kaydedildi?
Hayır
Yönetilen portal bağımlılıkları için ek sanal ağ bağlantısını etkinleştirmem gerekiyor mu?
Çoğu durumda - hayır.
API Management hizmetiniz bir iç sanal ağdaysa geliştirici portalınıza yalnızca ağ içinden erişilebilir. Yönetim uç noktasının ana bilgisayar adı, portalın yönetim arabirimine erişmek için kullandığınız makineden hizmetin iç VIP'sine çözümlenmelidir. Yönetim uç noktasının DNS'de kayıtlı olduğundan emin olun. Yanlış yapılandırma durumunda şu hatayı görürsünüz: Unable to start the portal. See if settings are specified correctly in the configuration (...).
API Management hizmetiniz bir iç sanal ağdaysa ve İnternet'ten Application Gateway üzerinden erişiyorsanız, geliştirici portalına ve API Management'ın yönetim uç noktalarına bağlantıyı etkinleştirdiğinizden emin olun. Web Uygulaması Güvenlik Duvarı kurallarını devre dışı bırakmanız gerekebilir. Diğer ayrıntılar için bu belge makalesine bakın.
Özel API Management etki alanı atadım ve yayımlanan portal çalışmıyor
Etki alanını güncelleştirdikten sonra değişikliklerin etkili olması için portalı yeniden yayımlamanız gerekir.
Bir kimlik sağlayıcısı ekledim ve portalda bu sağlayıcıyı göremiyorum
Bir kimlik sağlayıcısını (örneğin, Azure AD, Azure AD B2C) yapılandırdıktan sonra değişikliklerin etkili olması için portalı yeniden yayımlamanız gerekir. Geliştirici portalı sayfalarınızın OAuth düğmeleri pencere öğesini içerdiğinden emin olun.
Temsilci seçmeyi ayarladım ve portal bunu kullanmıyor
Temsilci seçmeyi ayarladıktan sonra değişikliklerin geçerli olması için portalı yeniden yayımlamanız gerekir.
Diğer API Management yapılandırma değişikliklerim geliştirici portalında yayılmadı
Yapılandırma değişikliklerinin çoğu (örneğin, VNet, oturum açma, ürün koşulları) portalın yeniden yayımlanmasını gerektirir.
Etkileşimli konsolu kullanırken CORS hatası alıyorum
Etkileşimli konsol, tarayıcıdan istemci tarafı API isteğinde bulunur. API'lerinize bir CORS ilkesi ekleyerek veya portalı CORS ara sunucusu kullanacak şekilde yapılandırarak CORS sorununu çözün. Daha fazla bilgi için bkz . API Management geliştirici portalında CORS'yi etkileşimli konsol için etkinleştirme.
Özel HTML kodu pencere öğesini kullanırken CORS hatası alıyorum
Ortamınızda özel HTML kodu pencere öğesini kullanırken, pencere öğesi tarafından yüklenen IFrame ile etkileşim kurarken CORS hatası görebilirsiniz. Bu sorun, IFrame'e geliştirici portalından farklı bir kaynaktan içerik sunulduğundan oluşur. Bu sorunu önlemek için bunun yerine özel bir pencere öğesi kullanabilirsiniz.
Geliştirici portalını düzenlemek için hangi izinlere ihtiyacım var?
Portalı yönetim modunda açtığınızda hatayı görüyorsanız Oops. Something went wrong. Please try again later. gerekli izinlere (Azure RBAC) sahip olmayabilirsiniz.
Portal kapsamında izin Microsoft.ApiManagement/service/users/token/action/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.ApiManagement/service/<apim-service-name>/users/1gerektirir.
Gerekli izne sahip bir rol oluşturmak için aşağıdaki PowerShell betiğini kullanabilirsiniz. Parametresini <subscription-id> değiştirmeyi unutmayın.
#New Portals Admin Role
Import-Module Az
Connect-AzAccount
$contributorRole = Get-AzRoleDefinition "API Management Service Contributor"
$customRole = $contributorRole
$customRole.Id = $null
$customRole.Name = "APIM New Portal Admin"
$customRole.Description = "This role gives the user ability to log in to the new Developer portal as administrator"
$customRole.Actions = "Microsoft.ApiManagement/service/users/token/action"
$customRole.IsCustom = $true
$customRole.AssignableScopes.Clear()
$customRole.AssignableScopes.Add('/subscriptions/<subscription-id>')
New-AzRoleDefinition -Role $customRole
Rol oluşturulduktan sonra, Azure portalındaki Erişim Denetimi (IAM) bölümünden herhangi bir kullanıcıya verilebilir. Bu rolü bir kullanıcıya atamak, hizmet kapsamında izni atar. Kullanıcı, hizmetteki herhangi bir kullanıcı adına SAS belirteçleri oluşturabilir. En azından bu rolün hizmetin yöneticisine atanması gerekir. Aşağıdaki PowerShell komutu, kullanıcıya user1 gereksiz izinler verilmesini önlemek için rolün kullanıcıya en düşük kapsamda nasıl atanmasını gösterir:
New-AzRoleAssignment -SignInName "user1@contoso.com" -RoleDefinitionName "APIM New Portal Admin" -Scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.ApiManagement/service/<apim-service-name>/users/1"
Kullanıcıya izinler verildikten sonra, yeni izinlerin geçerli olması için kullanıcının oturumu kapatması ve Azure portalında yeniden oturum açması gerekir.
Hatayı görüyorum Unable to start the portal. See if settings are specified correctly (...)
Çağrısı https://<management-endpoint-hostname>/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.ApiManagement/service/xxx/contentTypes/document/contentItems/configuration?api-version=2018-06-01-preview başarısız olduğunda GET bu hata gösterilir. Çağrı, portalın yönetim arabirimi tarafından tarayıcıdan verilir.
API Management hizmetiniz bir sanal ağdaysa sanal ağ bağlantısı sorusuna bakın.
Arama hatası, özel bir etki alanına atanan ve tarayıcı tarafından güvenilmeyen bir TLS/SSL sertifikasından da kaynaklanabilir. Bir azaltma olarak, yönetim uç noktası özel etki alanını kaldırabilirsiniz. API Management, güvenilen bir sertifikayla varsayılan uç noktaya geri döner.
Portal için tarayıcı desteği nedir?
| Tarayıcı | Desteklenir |
|---|---|
| Apple Safari | Evet1 |
| Google Chrome | Evet1 |
| Microsoft Edge | Evet1 |
| Microsoft Internet Explorer | Hayır |
| Mozilla Firefox | Evet1 |
1 En son iki üretim sürümünde desteklenir.
Şirket içinde barındırılan portalımın yerel geliştirmesi artık çalışmıyor
Geliştirici portalının yerel sürümünüz depolama hesabından veya API Management örneğinden bilgileri kaydedemiyorsa veya alamıyorsa SAS belirteçlerinin süresi dolmuş olabilir. Yeni belirteçler oluşturarak bunu düzeltebilirsiniz. Yönergeler için geliştirici portalını kendi kendine barındırma öğreticisine bakın.
Geliştirici portalında kaydolmayı devre dışı Nasıl yaparım??
Geliştirici portalında kaydolma işlevinin varsayılan olarak etkinleştirilmesine ihtiyacınız yoksa, bu özelliği şu adımlarla devre dışı bırakabilirsiniz:
Azure portalında API Management örneğine gidin.
Menüde Geliştirici portalı'nın altında Kimlikler'i seçin.
Listede görünen her kimlik sağlayıcısını silin. Her sağlayıcıyı seçin, bağlam menüsünü (...) ve ardından Sil'i seçin.
Geliştirici portalı yönetim arabirimine gidin.
Portal içeriğindeki Kaydolma bağlantılarını ve gezinti öğelerini kaldırın. Portal içeriğini özelleştirme hakkında bilgi için bkz . Öğretici: Geliştirici portalına erişme ve portalı özelleştirme.
Kullanıcıların doğrudan bu verilere gitme olasılığına karşı, kimlik verilerini girmek için kullanılan alanları kaldırmak için Kaydolma sayfası içeriğini değiştirin.
İsteğe bağlı olarak, Kaydolma sayfasını silin. Şu anda bu sayfayı listelemek ve silmek için contentItem REST API'lerini kullanıyorsunuz.
Değişikliklerinizi kaydedin ve portalı yeniden yayımlayın.
API Management hizmetime sağlanan geliştirici portalı içeriğini nasıl kaldırabilirim?
Geliştirici portalı GitHub scripts.v3/cleanup.bat deposundaki betikte gerekli parametreleri sağlayın ve betiği çalıştırın
cd scripts.v3
.\cleanup.bat
cd ..
Şirket içinde barındırılan geliştirici portalında çoklu oturum açma (SSO) kimlik doğrulamasını etkinleştirmek Nasıl yaparım??
Diğer kimlik doğrulama yöntemleri arasında geliştirici portalı çoklu oturum açmayı (SSO) destekler. Bu yöntemle kimlik doğrulaması yapmak için sorgu parametresindeki belirteçle çağrısı /signin-sso yapmanız gerekir:
https://contoso.com/signin-sso?token=[user-specific token]
Kullanıcı belirteçleri oluşturma
API Management REST API'sinin Paylaşılan Erişim Belirteci Alma işlemini kullanarak kullanıcıya özgü belirteçler (yönetici belirteçleri dahil) oluşturabilirsiniz.
Not
Belirtecin URL ile kodlanmış olması gerekir.
İlgili içerik
Geliştirici portalı hakkında daha fazla bilgi edinin:
- Yönetilen geliştirici portalına erişme ve portalı özelleştirme
- Geliştirici portalının işlevselliğini genişletin .
- Portalın şirket içinde barındırılan sürümünü ayarlama
Diğer kaynaklara göz atın: