API Management-ontwikkelaarsportal - veelgestelde vragen

  • Artikel

VAN TOEPASSING OP: Ontwikkelaar | Basic | Basic v2 | Standaard | Standard v2 | Premium

Wat moet ik doen als ik functionaliteit nodig heb die niet wordt ondersteund in de portal?

U hebt de volgende opties:

  • Gebruik voor kleine aanpassingen een ingebouwde widget om aangepaste HTML toe te voegen. Momenteel is de aangepaste HTML-codewidget niet beschikbaar in de v2-lagen van API Management.

  • Voor grotere aanpassingen maakt en uploadt u een aangepaste widget naar de beheerde ontwikkelaarsportal. Momenteel zijn aangepaste widgets niet beschikbaar in de v2-lagen van API Management.

  • De ontwikkelaarsportal zelf hosten, alleen als u wijzigingen moet aanbrengen in de kern van de codebasis van de ontwikkelaarsportal.

  • Open een functieaanvraag in de GitHub-opslagplaats.

Meer informatie over het aanpassen en uitbreiden van de functionaliteit van de ontwikkelaarsportal.

Kan ik meerdere ontwikkelaarsportals in één API Management-service hebben?

U kunt één beheerde portal en meerdere zelf-hostende portals hebben. De inhoud van alle portals wordt opgeslagen in dezelfde API Management-service, zodat deze identiek zijn. Als u het uiterlijk en de functionaliteit van portals wilt onderscheiden, kunt u deze zelf hosten met uw eigen aangepaste widgets die pagina's dynamisch aanpassen op runtime, bijvoorbeeld op basis van de URL.

Ondersteunt de portal Azure Resource Manager-sjablonen en/of is deze compatibel met API Management DevOps Resource Kit?

Nee

Wordt de inhoud van de portal opgeslagen met de functionaliteit voor back-up/herstel in API Management?

Nee

Moet ik extra VNet-connectiviteit inschakelen voor de afhankelijkheden van de beheerde portal?

In de meeste gevallen- nee.

Als uw API Management-service zich in een intern VNet bevindt, is uw ontwikkelaarsportal alleen toegankelijk vanuit het netwerk. De hostnaam van het beheereindpunt moet worden omgezet in het interne VIP van de service vanaf de computer die u gebruikt voor toegang tot de beheerinterface van de portal. Zorg ervoor dat het beheereindpunt is geregistreerd in de DNS. In het geval van onjuiste configuratie ziet u een fout: Unable to start the portal. See if settings are specified correctly in the configuration (...).

Als uw API Management-service zich in een intern VNet bevindt en u deze opent via Application Gateway vanaf internet, moet u verbinding met de ontwikkelaarsportal en de beheereindpunten van API Management inschakelen. Mogelijk moet u Web Application Firewall-regels uitschakelen. Zie dit documentatieartikel voor meer informatie.

Ik heb een aangepast API Management-domein toegewezen en de gepubliceerde portal werkt niet

Nadat u het domein hebt bijgewerkt, moet u de portal opnieuw publiceren om de wijzigingen van kracht te laten worden.

Ik heb een id-provider toegevoegd en ik zie deze niet in de portal

Nadat u een id-provider hebt geconfigureerd (bijvoorbeeld Azure AD, Azure AD B2C), moet u de portal opnieuw publiceren om de wijzigingen van kracht te laten worden. Zorg ervoor dat uw ontwikkelaarsportalpagina's de widget OAuth-knoppen bevatten.

Ik heb delegatie ingesteld en de portal gebruikt deze niet

Nadat u delegering hebt ingesteld, moet u de portal opnieuw publiceren om de wijzigingen van kracht te laten worden.

Mijn andere configuratiewijzigingen voor API Management zijn niet doorgegeven in de ontwikkelaarsportal

Voor de meeste configuratiewijzigingen (bijvoorbeeld VNet, aanmelding, producttermen) moet de portal opnieuw worden gepubliceerd.

Ik krijg een CORS-fout bij het gebruik van de interactieve console

De interactieve console maakt een API-aanvraag aan de clientzijde vanuit de browser. Los het CORS-probleem op door een CORS-beleid toe te voegen aan uw API('s) of de portal te configureren voor het gebruik van een CORS-proxy. Zie CORS inschakelen voor interactieve console in de API Management-ontwikkelaarsportal voor meer informatie.

Ik krijg een CORS-fout bij het gebruik van de aangepaste HTML-codewidget

Wanneer u de aangepaste HTML-codewidget in uw omgeving gebruikt, ziet u mogelijk een CORS-fout bij interactie met het IFrame dat door de widget is geladen. Dit probleem treedt op omdat het IFrame inhoud van een andere oorsprong heeft dan de ontwikkelaarsportal. U kunt dit probleem voorkomen door in plaats daarvan een aangepaste widget te gebruiken.

Welke machtigingen heb ik nodig om de ontwikkelaarsportal te bewerken?

Als u de Oops. Something went wrong. Please try again later. fout ziet wanneer u de portal opent in de beheermodus, hebt u mogelijk geen vereiste machtigingen (Azure RBAC).

Voor de portal is de machtiging Microsoft.ApiManagement/service/users/token/action voor het bereik /subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.ApiManagement/service/<apim-service-name>/users/1vereist.

U kunt het volgende PowerShell-script gebruiken om een rol te maken met de vereiste machtiging. Vergeet niet om de <subscription-id> parameter te wijzigen.

#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

Zodra de rol is gemaakt, kan deze worden verleend aan elke gebruiker vanuit de sectie Toegangsbeheer (IAM) in Azure Portal. Als u deze rol aan een gebruiker toewijst, wordt de machtiging toegewezen aan het servicebereik. De gebruiker kan SAS-tokens genereren namens elke gebruiker in de service. Deze rol moet minimaal worden toegewezen aan de beheerder van de service. De volgende PowerShell-opdracht laat zien hoe u de rol toewijst aan een gebruiker user1 in het laagste bereik om te voorkomen dat onnodige machtigingen aan de gebruiker worden verleend:

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"

Nadat de machtigingen aan een gebruiker zijn verleend, moet de gebruiker zich afmelden en opnieuw aanmelden bij Azure Portal om de nieuwe machtigingen van kracht te laten worden.

Ik zie de Unable to start the portal. See if settings are specified correctly (...) fout

Deze fout wordt weergegeven wanneer een GET aanroep mislukt https://<management-endpoint-hostname>/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.ApiManagement/service/xxx/contentTypes/document/contentItems/configuration?api-version=2018-06-01-preview . De aanroep wordt vanuit de browser uitgegeven door de beheerinterface van de portal.

Als uw API Management-service zich in een VNet bevindt, raadpleegt u de vraag over de VNet-connectiviteit.

De aanroepfout kan ook worden veroorzaakt door een TLS/SSL-certificaat dat is toegewezen aan een aangepast domein en niet wordt vertrouwd door de browser. Als beperking kunt u het aangepaste domein voor het beheereindpunt verwijderen. API Management valt terug op het standaardeindpunt met een vertrouwd certificaat.

Wat is de browserondersteuning voor de portal?

Browser Ondersteund
Apple Safari Ja1
Google Chrome Ja1
Microsoft Edge Ja1
Microsoft Internet Explorer Nee
Mozilla Firefox Ja1

1 Ondersteund in de twee nieuwste productieversies.

Lokale ontwikkeling van mijn zelf-hostende portal werkt niet meer

Als uw lokale versie van de ontwikkelaarsportal geen gegevens kan opslaan of ophalen uit het opslagaccount of API Management-exemplaar, zijn de SAS-tokens mogelijk verlopen. U kunt dit oplossen door nieuwe tokens te genereren. Raadpleeg de zelfstudie voor het zelf hosten van de ontwikkelaarsportal voor instructies.

Hoe kan ik registratie uitschakelen in de ontwikkelaarsportal?

Als u de registratiefunctionaliteit niet standaard hebt ingeschakeld in de ontwikkelaarsportal, kunt u deze uitschakelen met de volgende stappen:

  1. Blader in Azure Portal naar uw API Management-exemplaar.

  2. Selecteer Identiteiten onder De ontwikkelaarsportal in het menu.

  3. Verwijder elke id-provider die wordt weergegeven in de lijst. Selecteer elke provider, selecteer het contextmenu (...) en selecteer Verwijderen.

    Id-providers verwijderen

  4. Navigeer naar de beheerinterface van de ontwikkelaarsportal.

  5. Verwijder registratiekoppelingen en navigatie-items in de portalinhoud. Zie Zelfstudie: De ontwikkelaarsportal openen en aanpassen voor meer informatie over het aanpassen van portalinhoud.

  6. Wijzig de inhoud van de registratiepagina om velden te verwijderen die worden gebruikt om identiteitsgegevens in te voeren, voor het geval gebruikers er rechtstreeks naartoe navigeren.

    Verwijder eventueel de registratiepagina . Op dit moment gebruikt u de CONTENTItem REST API's om deze pagina weer te geven en te verwijderen.

  7. Sla uw wijzigingen op en publiceer de portal opnieuw.

Hoe kan ik de inhoud van de ontwikkelaarsportal verwijderen die is ingericht voor mijn API Management-service?

Geef de vereiste parameters op in het scripts.v3/cleanup.bat script in de GitHub-opslagplaats van de ontwikkelaarsportal en voer het script uit

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

Hoe kan ik eenmalige aanmelding (SSO) voor zelf-hostende ontwikkelaarsportal inschakelen?

Naast andere verificatiemethoden ondersteunt de ontwikkelaarsportal eenmalige aanmelding (SSO). Als u wilt verifiëren met deze methode, moet u een aanroep uitvoeren naar /signin-sso het token in de queryparameter:

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

Gebruikerstokens genereren

U kunt gebruikersspecifieke tokens genereren (inclusief beheerderstokens ) met behulp van de bewerking Gedeeld toegangstoken ophalen van de API Management REST API.

Notitie

Het token moet url-gecodeerd zijn.

Gerelateerde inhoud

Meer informatie over de ontwikkelaarsportal:

Door andere resources bladeren: