Utvecklarportal för API Management – vanliga frågor och svar

  • Artikel

GÄLLER FÖR: Utvecklare | Grundläggande | Basic v2 | Standard | Standard v2 | Premium

Vad händer om jag behöver funktioner som inte stöds i portalen?

Du kan välja mellan följande alternativ:

  • För små anpassningar använder du en inbyggd widget för att lägga till anpassad HTML. För närvarande är den anpassade HTML-kodwidgeten inte tillgänglig på v2-nivåerna i API Management.

  • För större anpassningar skapar och laddar du upp en anpassad widget till portalen för hanterad utvecklare. För närvarande är anpassade widgetar inte tillgängliga på v2-nivåerna i API Management.

  • Lokalt värd för utvecklarportalen, endast om du behöver göra ändringar i kärnan i utvecklarportalens kodbas.

  • Öppna en funktionsbegäran på GitHub-lagringsplatsen.

Läs mer om hur du anpassar och utökar funktionerna i utvecklarportalen.

Kan jag ha flera utvecklarportaler i en API Management-tjänst?

Du kan ha en hanterad portal och flera lokalt installerade portaler. Innehållet i alla portaler lagras i samma API Management-tjänst, så de är identiska. Om du vill särskilja portalernas utseende och funktioner kan du själv vara värd för dem med dina egna anpassade widgetar som dynamiskt anpassar sidor vid körning, till exempel baserat på URL:en.

Stöder portalen Azure Resource Manager-mallar och/eller är den kompatibel med API Management DevOps Resource Kit?

Nej.

Sparas portalens innehåll med funktionerna för säkerhetskopiering/återställning i API Management?

Nej.

Behöver jag aktivera ytterligare VNet-anslutning för de hanterade portalberoendena?

I de flesta fall – nej.

Om DIN API Management-tjänst finns i ett internt VNet är utvecklarportalen endast tillgänglig inifrån nätverket. Hanteringsslutpunktens värdnamn måste matcha den interna VIP-adressen för tjänsten från den dator som du använder för att få åtkomst till portalens administrativa gränssnitt. Kontrollera att hanteringsslutpunkten är registrerad i DNS. Vid felkonfiguration visas ett fel: Unable to start the portal. See if settings are specified correctly in the configuration (...).

Om DIN API Management-tjänst finns i ett internt virtuellt nätverk och du kommer åt den via Application Gateway från Internet måste du aktivera anslutningen till utvecklarportalen och hanteringsslutpunkterna för API Management. Du kan behöva inaktivera brandväggsregler för webbaserade program. Mer information finns i den här dokumentationsartikeln .

Jag har tilldelat en anpassad API Management-domän och den publicerade portalen fungerar inte

När du har uppdaterat domänen måste du publicera om portalen för att ändringarna ska börja gälla.

Jag har lagt till en identitetsprovider och jag kan inte se den i portalen

När du har konfigurerat en identitetsprovider (till exempel Azure AD, Azure AD B2C) måste du publicera om portalen för att ändringarna ska börja gälla. Se till att utvecklarportalsidorna innehåller widgeten OAuth-knappar.

Jag har konfigurerat delegering och portalen använder den inte

När du har konfigurerat delegering måste du publicera om portalen för att ändringarna ska börja gälla.

Mina andra API Management-konfigurationsändringar har inte spridits i utvecklarportalen

De flesta konfigurationsändringar (till exempel VNet, inloggning, produktvillkor) kräver att portalen publiceras på nytt.

Jag får ett CORS-fel när jag använder den interaktiva konsolen

Den interaktiva konsolen gör en API-begäran på klientsidan från webbläsaren. Lös CORS-problemet genom att lägga till en CORS-princip på dina API:er eller konfigurera portalen så att den använder en CORS-proxy. Mer information finns i Aktivera CORS för interaktiv konsol i API Management-utvecklarportalen.

Jag får ett CORS-fel när jag använder den anpassade HTML-kodwidgeten

När du använder den anpassade HTML-kodwidgeten i din miljö kan du se ett CORS-fel när du interagerar med den IFrame som läses in av widgeten. Det här problemet beror på att IFrame hanteras innehåll från ett annat ursprung än utvecklarportalen. För att undvika det här problemet kan du använda en anpassad widget i stället.

Vilka behörigheter behöver jag för att redigera utvecklarportalen?

Om du får Oops. Something went wrong. Please try again later. felet när du öppnar portalen i administrativt läge kanske du saknar de behörigheter som krävs (Azure RBAC).

Portalen kräver behörigheten Microsoft.ApiManagement/service/users/token/action i omfånget /subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.ApiManagement/service/<apim-service-name>/users/1.

Du kan använda följande PowerShell-skript för att skapa en roll med nödvändig behörighet. Kom ihåg att ändra parametern <subscription-id> .

#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

När rollen har skapats kan den beviljas alla användare från avsnittet Åtkomstkontroll (IAM) i Azure-portalen. Om du tilldelar den här rollen till en användare tilldelas behörigheten i tjänstomfånget. Användaren kommer att kunna generera SAS-token för alla användare i tjänsten. Den här rollen måste minst tilldelas till administratören för tjänsten. Följande PowerShell-kommando visar hur du tilldelar rollen till en användare user1 med det lägsta omfånget för att undvika att bevilja onödiga behörigheter till användaren:

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"

När behörigheterna har beviljats en användare måste användaren logga ut och logga in igen på Azure-portalen för att de nya behörigheterna ska börja gälla.

Jag ser felet Unable to start the portal. See if settings are specified correctly (...)

Det här felet visas när ett GET anrop till https://<management-endpoint-hostname>/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.ApiManagement/service/xxx/contentTypes/document/contentItems/configuration?api-version=2018-06-01-preview misslyckas. Anropet utfärdas från webbläsaren av det administrativa gränssnittet i portalen.

Om API Management-tjänsten finns i ett virtuellt nätverk kan du läsa frågan om VNet-anslutning.

Anropsfelet kan också orsakas av ett TLS/SSL-certifikat, som har tilldelats till en anpassad domän och inte är betrodd av webbläsaren. Som en åtgärd kan du ta bort den anpassade domänen för hanteringsslutpunkten. API Management återgår till standardslutpunkten med ett betrott certifikat.

Vad är webbläsarstöd för portalen?

Webbläsare Stöds
Apple Safari Ja1
Google Chrome Ja1
Microsoft Edge Ja1
Microsoft Internet Explorer Nej
Mozilla Firefox Ja1

1 Stöds i de två senaste produktionsversionerna.

Den lokala utvecklingen av min lokala portal fungerar inte längre

Om din lokala version av utvecklarportalen inte kan spara eller hämta information från lagringskontot eller API Management-instansen kan SAS-token ha upphört att gälla. Du kan åtgärda det genom att generera nya token. Anvisningar finns i självstudiekursen för att själv vara värd för utvecklarportalen.

Hur gör jag för att inaktivera registrering i utvecklarportalen?

Om du inte behöver registreringsfunktionen aktiverad som standard i utvecklarportalen kan du inaktivera den med följande steg:

  1. I Azure-portalen går du till din API Management-instans.

  2. Under Utvecklarportalen på menyn väljer du Identiteter.

  3. Ta bort varje identitetsprovider som visas i listan. Välj varje provider, välj snabbmenyn (...) och välj Ta bort.

    Ta bort identitetsprovidrar

  4. Gå till administrationsgränssnittet för utvecklarportalen.

  5. Ta bort registreringslänkar och navigeringsobjekt i portalinnehållet. Information om hur du anpassar portalinnehåll finns i Självstudie: Komma åt och anpassa utvecklarportalen.

  6. Ändra innehållet på registreringssidan för att ta bort fält som används för att ange identitetsdata, om användarna navigerar direkt till den.

    Du kan också ta bort sidan Registrera dig. För närvarande använder du contentItem REST API:er för att lista och ta bort den här sidan.

  7. Spara ändringarna och publicera portalen igen.

Hur tar jag bort utvecklarportalens innehåll som har etablerats till min API Management-tjänst?

Ange de obligatoriska parametrarna i skriptet scripts.v3/cleanup.bat på GitHub-lagringsplatsen för utvecklarportalen och kör skriptet

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

Hur gör jag för att aktivera enkel inloggningsautentisering (SSO) till en lokalt installerad utvecklarportal?

Utvecklarportalen har bland annat stöd för enkel inloggning (SSO). Om du vill autentisera med den här metoden måste du göra ett anrop till /signin-sso med token i frågeparametern:

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

Generera användartoken

Du kan generera användarspecifika token (inklusive administratörstoken) med hjälp av åtgärden Hämta delad åtkomsttoken i API Management REST API.

Kommentar

Token måste vara URL-kodad.

Relaterat innehåll

Läs mer om utvecklarportalen:

Bläddra bland andra resurser: