Vývojářský portál služby API Management – Nejčastější dotazy

  • Článek

PLATÍ PRO: Vývojář | Základní | Basic v2 | Standardní | Standard v2 | Premium

Co když potřebuji funkce, které nejsou na portálu podporované?

Máte tyto možnosti:

  • V případě malých přizpůsobení použijte předdefinovaný widget pro přidání vlastního KÓDU HTML. V současné době není vlastní widget kódu HTML dostupný ve vrstvách v2 služby API Management.

  • Pro větší přizpůsobení vytvořte a nahrajte vlastní widget na spravovaný portál pro vývojáře. V současné době nejsou vlastní widgety dostupné ve vrstvách v2 služby API Management.

  • Samoobslužné hostování portálu pro vývojáře, pouze pokud potřebujete upravit jádro základu kódu portálu pro vývojáře.

  • Otevřete žádost o funkci v úložišti GitHub.

Přečtěte si další informace o přizpůsobení a rozšíření funkcí portálu pro vývojáře.

Můžu mít v jedné službě API Management více vývojářských portálů?

Můžete mít jeden spravovaný portál a několik samoobslužných portálů. Obsah všech portálů je uložený ve stejné službě API Management, takže budou identické. Pokud chcete odlišit vzhled a funkce portálů, můžete je sami hostovat pomocí vlastních widgetů, které dynamicky přizpůsobí stránky za běhu, například na základě adresy URL.

Podporuje portál šablony Azure Resource Manageru nebo je kompatibilní se sadou API Management DevOps Resource Kit?

Ne.

Ukládá se obsah portálu s funkcí zálohování a obnovení ve službě API Management?

Ne.

Musím pro závislosti spravovaného portálu povolit další připojení virtuální sítě?

Ve většině případů ne.

Pokud je vaše služba API Management v interní virtuální síti, váš vývojářský portál je přístupný jenom ze sítě. Název hostitele koncového bodu správy se musí přeložit na interní VIRTUÁLNÍ IP adresu služby z počítače, který používáte pro přístup k rozhraní pro správu portálu. Ujistěte se, že je koncový bod správy zaregistrovaný v DNS. V případě chybné konfigurace se zobrazí chyba: Unable to start the portal. See if settings are specified correctly in the configuration (...).

Pokud je vaše služba API Management v interní virtuální síti a přistupujete k ní prostřednictvím služby Application Gateway z internetu, nezapomeňte povolit připojení k portálu pro vývojáře a koncovým bodům správy služby API Management. Možná budete muset zakázat pravidla firewallu webových aplikací. Další podrobnosti najdete v tomto článku dokumentace.

Přiřadil(a) jsem vlastní doménu služby API Management a publikovaný portál nefunguje

Po aktualizaci domény je nutné znovu publikovat portál , aby se změny projevily.

Přidali jsem zprostředkovatele identity a na portálu se nezobrazuje

Jakmile nakonfigurujete zprostředkovatele identity (například Azure AD, Azure AD B2C), budete muset portál znovu publikovat, aby se změny projevily. Ujistěte se, že stránky portálu pro vývojáře obsahují widget tlačítek OAuth.

Nastavení delegování a portál ho nepoužívá

Po nastavení delegování je potřeba portál znovu publikovat, aby se změny projevily.

Moje další změny konfigurace služby API Management nebyly rozšířeny na portálu pro vývojáře

Většina změn konfigurace (například virtuální síť, přihlášení, podmínky produktu) vyžaduje opětovné publikování portálu.

Při používání interaktivní konzoly se zobrazuje chyba CORS

Interaktivní konzola vytvoří požadavek rozhraní API na straně klienta z prohlížeče. Vyřešte problém CORS přidáním zásad CORS do vašich rozhraní API nebo konfigurací portálu tak, aby používal proxy CORS. Další informace najdete v tématu Povolení CORS pro interaktivní konzolu na portálu pro vývojáře služby API Management.

Při použití vlastního widgetu kódu HTML se zobrazuje chyba CORS

Při použití vlastního widgetu kódu HTML ve vašem prostředí se může při interakci s elementem IFrame načteným widgetem zobrazit chyba CORS. K tomuto problému dochází, protože element IFrame se obsluhuje obsah z jiného původu než portál pro vývojáře. Pokud se chcete tomuto problému vyhnout, můžete místo toho použít vlastní widget.

Jaká oprávnění potřebuji k úpravě portálu pro vývojáře?

Oops. Something went wrong. Please try again later. Pokud se vám při otevření portálu v režimu správy zobrazuje chyba, může vám chybět požadovaná oprávnění (Azure RBAC).

Portál vyžaduje oprávnění Microsoft.ApiManagement/service/users/token/action v oboru /subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.ApiManagement/service/<apim-service-name>/users/1.

K vytvoření role s požadovaným oprávněním můžete použít následující skript PowerShellu. Nezapomeňte změnit <subscription-id> parametr.

#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

Po vytvoření role ji může udělit libovolnému uživateli z oddílu Řízení přístupu (IAM) na webu Azure Portal. Přiřazení této role uživateli přiřadí oprávnění v oboru služby. Uživatel bude moct generovat tokeny SAS jménem libovolného uživatele ve službě. Tato role musí být minimálně přiřazena správci služby. Následující příkaz PowerShellu ukazuje, jak přiřadit roli uživateli user1 v nejnižším oboru, aby se zabránilo udělení zbytečných oprávnění uživateli:

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"

Po udělení oprávnění uživateli se uživatel musí odhlásit a znovu se přihlásit k webu Azure Portal, aby se nová oprávnění projevila.

Zobrazuje se Unable to start the portal. See if settings are specified correctly (...) mi chyba

Tato chyba se zobrazí, když GET dojde k https://<management-endpoint-hostname>/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.ApiManagement/service/xxx/contentTypes/document/contentItems/configuration?api-version=2018-06-01-preview selhání volání. Volání se vydává z prohlížeče rozhraním pro správu portálu.

Pokud je vaše služba API Management ve virtuální síti, projděte si otázku připojení k virtuální síti.

Selhání volání může být způsobeno také certifikátem TLS/SSL, který je přiřazený k vlastní doméně a prohlížeč ji nevěřuje. Jako zmírnění rizik můžete vlastní doménu koncového bodu správy odebrat. Služba API Management se vrátí k výchozímu koncovému bodu s důvěryhodným certifikátem.

Jaká je podpora prohlížeče pro portál?

Prohlížeč Podporováno
Apple Safari Ano1
Google Chrome Ano1
Microsoft Edge Ano1
Microsoft Internet Explorer No
Mozilla Firefox Ano1

1 Podporováno ve dvou nejnovějších produkčních verzích.

Místní vývoj místního portálu už nefunguje

Pokud vaše místní verze portálu pro vývojáře nemůže uložit nebo načíst informace z účtu úložiště nebo instance služby API Management, možná vypršela platnost tokenů SAS. Můžete to vyřešit generováním nových tokenů. Pokyny najdete v kurzu pro samoobslužné hostování portálu pro vývojáře.

Návody zakázat registraci na portálu pro vývojáře?

Pokud ve výchozím nastavení na portálu pro vývojáře nepotřebujete funkci registrace, můžete ji zakázat pomocí následujícího postupu:

  1. Na webu Azure Portal přejděte k vaší instanci služby API Management.

  2. V části Portál pro vývojáře v nabídce vyberte Identityies.

  3. Odstraňte zprostředkovatele identity, který se zobrazí v seznamu. Vyberte každého zprostředkovatele, vyberte místní nabídku (...) a vyberte Odstranit.

    Odstranění zprostředkovatelů identity

  4. Přejděte do rozhraní pro správu portálu pro vývojáře.

  5. Odeberte odkazy pro registraci a navigační položky v obsahu portálu. Informace o přizpůsobení obsahu portálu najdete v tématu Kurz: Přístup a přizpůsobení portálu pro vývojáře.

  6. Upravte obsah stránky registrace tak, aby se odebrala pole použitá k zadání dat identity, pokud k němu uživatelé přechází přímo.

    Volitelně můžete odstranit registrační stránku. V současné době používáte rozhraní REST API contentItem k výpisu a odstranění této stránky.

  7. Uložte změny a znovu publikujte portál.

Jak můžu odebrat obsah portálu pro vývojáře zřízený pro službu API Management?

Zadejte požadované parametry ve scripts.v3/cleanup.bat skriptu v úložišti GitHub na portálu pro vývojáře a spusťte skript.

cd scripts.v3
.\cleanup.bat
cd ..

Návody povolit ověřování jednotného přihlašování (SSO) na portálu pro vývojáře v místním prostředí?

Portál pro vývojáře kromě jiných metod ověřování podporuje jednotné přihlašování (SSO). Pokud chcete provést ověření pomocí této metody, musíte provést volání /signin-sso pomocí tokenu v parametru dotazu:

https://contoso.com/signin-sso?token=[user-specific token]

Generování tokenů uživatele

Tokeny specifické pro uživatele (včetně tokenů správce) můžete vygenerovat pomocí operace Získání sdíleného přístupového tokenu rozhraní REST API služby API Management.

Poznámka:

Token musí být kódovaný adresou URL.

Související obsah

Další informace o portálu pro vývojáře:

Procházet další zdroje informací: