You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-center/includes/api-center-portal-app-registration.md
-4Lines changed: 0 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,10 +23,6 @@ First configure an app registration in your Microsoft Entra ID tenant. The app r
23
23
* Under **Supported account types**, select **Accounts in this organizational directory (Single tenant)**.
24
24
* In **Redirect URI**, select **Single-page application (SPA)** and set the URI.
25
25
Enter the URI of your API Center portal deployment, in the following form: `https://<service-name>.portal.<location>.azure-api-center.ms`. Replace `<service name>` and `<location>` with the name of your API center and the location where it's deployed, Example: `https://myapicenter.portal.eastus.azure-api-center.ms`.
26
-
27
-
> [!TIP]
28
-
> If you are self-hosting the portal and what to test it locally before deploying to Azure, you can set the URI to `https://localhost:5173`.
29
-
30
26
* Select **Register**.
31
27
1. On the **Overview** page, copy the **Application (client) ID**. You set this value when you publish the portal.
Copy file name to clipboardExpand all lines: articles/api-center/includes/api-center-portal-compare-apim-dev-portal.md
+9-15Lines changed: 9 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,30 +13,24 @@ ms.custom: Include file
13
13
14
14
## Which portal to use: API Management's or API Center's?
15
15
16
-
The [Azure API Management](../../api-management/api-management-key-concepts.md)service and the [Azure API Center](../overview.md)service both offer portals for developers and other API users to discover and consume an organization's APIs:
16
+
The [Azure API Management](../../api-management/api-management-key-concepts.md) and [Azure API Center](../overview.md)services both provide portals for developers to discover and consume APIs:
17
17
18
-
* In API Management, the *developer portal* is where developers and API consumers can discover the APIs managed APIs, learn how to use them, request access, and try them out.
18
+
* The *API Management developer portal* allows users to find managed APIs, learn how to use them, request access, and test them.
19
+
* The *API Center portal* enables users to discover and filter the API inventory.
19
20
20
-
* In API Center, the *API Center portal* is where developers and API consumers can discover and filter the API inventory and review API definitions and documentation.
21
+
While the two portals share some features, they also have distinct differences. The following table compares key capabilities to help determine which portal to use. Some organizations may prefer one portal, while others may need both.
21
22
22
-
The portals have some common features, but also some distinct differences. Especially in organizations that adopt both services, the question arises: *Which portal should I use?* The following table compares key capabilities of the two portals. For some organizations, one portal may be preferable; for some, both may be needed.
23
-
24
-
| Feature | API Management portal | API Center portal |
23
+
| Feature | API Management developer portal | API Center portal |
25
24
| --- | --- | --- |
26
-
|Browse APIs in API Management instance | Yes | Yes<sup>1</sup>|
27
-
|Browse APIs in entire inventory | No|Yes<sup>1</sup>|
25
+
|Audience| External and internal developers | Internal developers|
26
+
|API inventory | API Management instance only|All APIs|
28
27
| Search and filter APIs | No | Yes |
29
28
| View API details and definitions | Yes | Yes |
30
29
| View API documentation | Yes | Yes |
31
-
|Configure basic branding | Yes |Yes|
30
+
|Customize with branding | Yes |Name only|
32
31
| Add custom widgets | Yes | No |
33
-
| Self-host | Yes | Yes |
34
32
| Customize with WordPress | Yes | No |
35
33
| Integrate with Microsoft Entra | Yes | Yes |
36
-
| Access publicly | Yes | No |
37
34
| Test APIs in test console | Yes | No |
38
35
| Subscribe to APIs | Yes | No |
39
-
| View API usage analytics | Yes | No |
40
-
41
-
<sup>2</sup> Depends on import or integration of APIs from API sources.
Copy file name to clipboardExpand all lines: articles/api-center/self-host-api-center-portal.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ This article shows how to self-host the *API Center portal*, a website that deve
17
17
:::image type="content" source="media/self-host-api-center-portal/api-center-portal-signed-in.png" alt-text="Screenshot of the API Center portal after user sign-in.":::
18
18
19
19
> [!TIP]
20
-
> You can also set up an Azure-managed version of the API Center portal. For more information, see [Set up the API Center portal](set-up-api-center-portal.md).
20
+
> New! You can now set up an Azure-managed version of the API Center portal. For more information, see [Set up the API Center portal](set-up-api-center-portal.md).
21
21
22
22
## About self-hosting the portal
23
23
@@ -30,7 +30,7 @@ The API Center portal reference implementation provides:
30
30
* Flexibility to host on different infrastructures, including deployment to services such as Azure Static Web Apps.
31
31
32
32
> [!NOTE]
33
-
> When you self-host the API Center portal, you become its maintainer and you're responsible for its upgrades.
33
+
> When you self-host the API Center portal, you become its maintainer and you're responsible for its upgrades. Azure support is limited.
> When you're self-hosting the portal and want to test it locally before deploying to Azure, set the redirect URI in the app registration to `https://localhost:5173`.
46
+
44
47
## Configure local environment
45
48
46
49
Follow these steps to build and test the API Center portal locally.
Copy file name to clipboardExpand all lines: articles/api-center/set-up-api-center-portal.md
+17-10Lines changed: 17 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,12 +12,12 @@ ms.custom:
12
12
13
13
# Set up your API Center portal
14
14
15
-
This article shows you how to set up the *API Center portal*, an Azure-managed website that developers and other stakeholders in your organization can use to discover the APIs in your [API center](overview.md). Signed-in users can browse and filter APIs and view API details such as API definitions and documentation. User access to API information is based on Microsoft Entra ID and Azure role-based access control.
15
+
This article shows you how to set up the *API Center portal* (preview), an Azure-managed website that developers and other stakeholders in your organization can use to discover the APIs in your [API center](overview.md). Signed-in users can browse and filter APIs and view API details such as API definitions and documentation. User access to API information is based on Microsoft Entra ID and Azure role-based access control.
16
16
17
17
:::image type="content" source="media/self-host-api-center-portal/api-center-portal-signed-in.png" alt-text="Screenshot of the API Center portal after user sign-in.":::
18
18
19
-
> [!TIP]
20
-
> If you want capabilities to customize the portal, you can self-host the API Center portal. For more information, see [Self-host the API Center portal](self-host-api-center-portal.md).
@@ -27,9 +27,6 @@ This article shows you how to set up the *API Center portal*, an Azure-managed w
27
27
28
28
After you create the API Center portal app registration, you need to configure and publish the API center portal. Complete the following steps in the Azure portal.
29
29
30
-
> [!IMPORTANT]
31
-
> After publishing the API center portal, you can't unpublish it. If you need to stop using the portal, you can delete the app registration in Microsoft Entra ID.
32
-
33
30
1. In the [Azure portal](https://portal.azure.com), navigate to your API center.
34
31
1. In the left menu, under **API Center portal**, select **Portal settings**.
35
32
:::image type="content" source="media/set-up-api-center-portal/configure-portal-settings.png" alt-text="Screenshot of API Center portal settings in the Azure portal.":::
@@ -38,9 +35,20 @@ After you create the API Center portal app registration, you need to configure a
38
35
1. Confirm that the **Redirect URI** is the value you configured in the app registration.
39
36
1. Select **Save + publish**.
40
37
1. On the **Site profile** tab, enter a website name that you want to appear in the top bar of the API Center portal. Select **Save + publish**.
41
-
1. On the **API visibility** tab, optionally configure filters for the APIs you want to make visible in the portal. Select **Save + publish**.
38
+
1. On the **API visibility** tab, optionally add filters for APIs that you want to make discoverable in the portal. Select **Save + publish**. [Learn more about API visibility](#api-visibility).
39
+
40
+
You can now access the API Center portal:
41
+
* On the **Portal settings** page, select **View API Center portal** to open the portal in a new tab.
42
+
* Or, enter the following URL in your browser, replacing `<service-name>` and `<location>` with the name of your API center and the location where it's deployed:<br/><br/>
You can now access the API Center portal. On the **Portal settings** page, select **View API Center portal** to open the portal in a new tab.
47
+
API visibility settings control which APIs are discoverable (visible) to API Center portal users. The API Center portal uses the data plane API to retrieve and display APIs, and by default retrieves all APIs in your API center.
48
+
49
+
To make only specific APIs visible, go to the **API visibility** tab in the API Center portal settings. Here, add filter conditions for APIs based on built-in or custom API [metadata](metadata.md) properties. For instance, you can choose to display APIs only of certain types (like REST or GraphQL) or based on certain specification formats (such as OpenAPI). Additionally, you can select values of custom metadata properties that categorize your APIs.
50
+
51
+
:::image type="content" source="media/set-up-api-center-portal/add-visibility-condition.png" alt-text="Screeshot of adding API visibility conditions in the portal.":::
0 commit comments