Konfigurera API Center-portalen

Den här artikeln visar hur du konfigurerar API Center-portalen (förhandsversion), en Azure-hanterad webbplats som utvecklare och andra intressenter i din organisation använder för att identifiera API:erna i API-centret. Inloggade användare kan bläddra bland och filtrera API:er och visa API-information, till exempel API-definitioner och dokumentation. Användaråtkomst till API-information baseras på Microsoft Entra-ID och rollbaserad åtkomstkontroll i Azure.

Förutsättningar

• Ett API-center i din Azure-prenumeration. Om du inte redan har skapat ett kan du läsa Snabbstart: Skapa ditt API-center.

• Behörigheter för att skapa en appregistrering i en Microsoft Entra-klientorganisation som är associerad med din Azure-prenumeration och behörigheter för att bevilja åtkomst till data i api-centret.

Skapa Microsoft Entra-appregistrering

Först konfigurerar du en applikationsregistrering i din Microsoft Entra ID-klientorganisation. Appregistreringen gör det möjligt för API Center-portalen att komma åt data från ditt API Center för en inloggad användare.

API Center kan konfigurera appregistreringen automatiskt, eller så kan du skapa appregistreringen manuellt.

Konfigurera appregistreringen automatiskt

Följ dessa steg för att konfigurera appregistreringen automatiskt:

1. I Azure Portal går du till API-centret.
2. I den vänstra menyn väljer duINSTÄLLNINGAR för >.
3. På fliken Identitetsprovider väljer du Starta konfiguration.
4. På fliken Snabbkonfiguration väljer du Spara + publicera.

Om du behöver komma åt appregistreringen senare kan du hitta den i portalen under Appregistreringar. Programmet heter med följande format: <api-center-name-apic-aad>.

Konfigurera appregistreringen manuellt

Följ dessa steg om du vill skapa appregistreringen manuellt:

1. I Azure-portalen går du till Microsoft Entra ID>Hantera>appregistreringar.

2. Välj + Ny registrering.

3. På sidan Registrera ett program anger du följande värden:

   1. Ange Namn till ett beskrivande namn, till exempel api-center-portal
   2. Under Kontotyper som stöds väljer du Endast Konton i den här organisationskatalogen (<Katalognamn> – Enskild klient).
   3. I Omdirigerings-URI väljer du Enkelsidigt program (SPA) och anger URI:n. Ange URI:n för distributionen av API Center-portalen i följande formulär: https://<service-name>.portal.<location>.azure-apicenter.ms. Ersätt <service name> och <location> med namnet på ditt API-center och platsen där det distribueras, Exempel: https://myapicenter.portal.eastus.azure-apicenter.ms.
   4. Välj Registrera.

Konfigurera ytterligare omdirigerings-URI:er för VS Code-tillägget

När du aktiverar API Center-portalvyn i Visual Studio Code-tillägget för API Center konfigurerar du även följande omdirigerings-URI:er i appregistreringen:

1. Gå till din appregistrering i Azure-portalen.

2. På sidan Hantera>autentisering väljer du Lägg till en plattform och väljer Mobil- och skrivbordsprogram.

3. Konfigurera följande tre anpassade omdirigerings-URI:er:
   https://vscode.dev/redirect
http://localhost
ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>
   

   Ersätt <application-client-id> med programmets (klient)-ID för den här appen. Du hittar det här värdet på sidan Översikt för appregistreringen.

Konfigurera och publicera API Center-portalen

När du har skapat appregistreringen för API Center-portalen kan du anpassa inställningarna och publicera API Center-portalen. Slutför följande steg i Azure-portalen.

1. I Azure Portal går du till API-centret.

2. I den vänstra menyn går du till API Center-portalen och väljer Inställningar.

   

3. Om du konfigurerar en appregistrering manuellt väljer du Starta konfiguration på fliken Identitetsprovider. Om du använde snabbkonfigurationen är det här steget redan klart och du kan fortsätta till inställningarna på andra flikar.

   1. På fliken Manuell i Klient-ID anger du program-ID :t (klient) från appregistreringen som du skapade i föregående avsnitt.
   2. Bekräfta att omdirigerings-URI:n är det värde som du konfigurerade i appregistreringen.
   3. Välj Spara + publicera.

4. På de återstående flikarna kan du också anpassa inställningarna för API Center-portalen. Information om inställningarna finns i Anpassa API Center-portalen.

5. Välj Spara + publicera.

Få åtkomst till portalen

När du har publicerat kan du komma åt API Center-portalen i webbläsaren.

• På sidan Inställningar i portalen väljer du Visa API Center-portalen för att öppna portalen på en ny flik.
• Du kan också ange följande URL i webbläsaren och ersätta <service-name> och <location> med namnet på ditt API Center och platsen där det distribueras:
  https://<service-name>.portal.<location>.azure-apicenter.ms

Portalens startsida kan som standard nås offentligt men kräver inloggning för att få åtkomst till API:er. Mer information om hur du konfigurerar användaråtkomst till portalen finns i Aktivera inloggning till portalen av Microsoft Entra-användare och -grupper .

Aktivera inloggning till portalen av Microsoft Entra-användare och -grupper

Om du vill aktivera inloggning till API Center-portalen för åtkomst till API:er tilldelar du rollen Azure API Center Data Reader till användare eller grupper i din organisation, som är begränsad till DITT API Center.

Detaljerade krav och steg för att tilldela en roll till användare och grupper finns i Tilldela Azure-roller med hjälp av Azure-portalen. Korta steg följer:

1. I Azure Portal går du till API-centret.
2. I den vänstra menyn väljer du Åtkomstkontroll (IAM)>+ Lägg till rolltilldelning.
3. I fönstret Lägg till rolltilldelning anger du följande värden:
   1. På sidan Roll söker du efter och väljer Azure API Center Data Reader. Välj Nästa.
   2. På sidan Medlemmar går du till Tilldela åtkomst till och väljer Användare, grupp eller tjänstens huvudnamn>+ Välj medlemmar.
   3. På sidan Välj medlemmar söker du efter och väljer de användare eller grupper som rollen ska tilldelas till. Klicka på Välj och sedan på Nästa.
   4. Granska rolltilldelningen och välj Granska och tilldela.

När du har konfigurerat åtkomst till portalen kan konfigurerade användare logga in på portalen och visa API:erna i API-centret.

API-identifiering och förbrukning i API Center-portalen

API Center-portalen stöder och effektiviserar arbetet för utvecklare som använder och skapar API:er i din organisation. Inloggade användare kan:

• Söka efter API:er efter namn eller med hjälp av AI-assisterad semantisk sökning

• Filtrera API:er efter typ eller livscykelsteg

• Visa API-information och definitioner , inklusive slutpunkter, metoder, parametrar och svarsformat

• Ladda ned API-definitioner till en lokal dator eller öppna dem i Visual Studio Code

• Prova API:er som stöder API-nyckelautentisering eller OAuth 2.0-auktorisering

API Management- och API Center-portaler

Azure API Management- och Azure API Center-tjänsterna tillhandahåller båda portaler där utvecklare kan identifiera och använda API:er:

• Med API Management-utvecklarportalen kan användare hitta hanterade API:er, lära sig hur de använder dem, begära åtkomst och testa dem.
• API Center-portalen (förhandsversion) är en portal med flera gatewayer där användarna kan identifiera och filtrera organisationens fullständiga API-inventering.

De två portalerna delar vissa funktioner, men de har också distinkta skillnader. I följande tabell jämförs aktuella funktioner för att avgöra vilken portal som ska användas. Vissa organisationer kanske föredrar en portal, medan andra kan behöva båda.

¹ API Center-portalen kan innehålla alla API:er i din organisation, inklusive de som hanteras i Azure API Management och andra plattformar, samt ohanterade API:er och API:er under utveckling.

Relaterat innehåll

• Anpassa API Center-portalen
• Aktivera och visa Azure API Center-portalen i Visual Studio Code
• Självvärd för API Center-portalen