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/set-up-api-center-portal.md
+15-16Lines changed: 15 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,15 +14,15 @@ ms.collection:
14
14
15
15
# Set up and customize your API Center portal
16
16
17
-
This article shows you how to set up and customize the *API Center portal* (preview), an Azure-managed website that developers and other stakeholders in your organization use to discover the APIs, MCP servers, and related assets in your [API center](overview.md).
17
+
This article shows you how to set up and customize the *API Center portal* (preview), an Azure-managed website for discovering APIs, MCP servers, and related assets in your [API center](overview.md).
18
18
19
19
The API Center portal supports and streamlines the work of developers who use and create APIs within your organization. Users with access can:
20
20
21
21
***Search for APIs** by name or use AI-assisted semantic search.
22
22
***Filter APIs** by type or lifecycle stage.
23
23
***View API details and definitions** including endpoints, methods, parameters, and response formats.
24
-
***Download API definitions** to a local computer or open them in Visual Studio Code.
25
-
***Try out APIs**that support API key authentication or OAuth 2.0 authorization.
24
+
***Download API definitions** to your computer or open in Visual Studio Code.
25
+
***Try out APIs**with API key or OAuth 2.0 authentication.
26
26
27
27
:::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.":::
28
28
@@ -44,7 +44,7 @@ First, choose how you want users to access the API Center portal. You can set up
44
44
45
45
### Option 2: Allow anonymous access to the portal
46
46
47
-
To set up the API Center portal with anonymous access enabled, follow these steps.
47
+
To enable anonymous access, follow these steps.
48
48
49
49
> [!CAUTION]
50
50
> If you configure anonymous access, anyone can view the APIs in your API center without signing in. Don't expose sensitive information in API definitions or settings.
@@ -59,13 +59,12 @@ To set up the API Center portal with anonymous access enabled, follow these step
59
59
<aid="access-the-portal"></a>
60
60
## View the portal
61
61
62
-
After configuring access, go to the API Center portal in your browser.
62
+
After configuring access, open the API Center portal by selecting **View API Center portal** on the **Settings** page, or visit:<br/>
* On the portal's **Settings** page, select **View API Center portal** to open the portal in a new tab.
65
-
* 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/>
(Replace `<service-name>` and `<location>` with your API center name and deployment location.)
67
66
68
-
By default, the portal home page is reachable publicly. If Microsoft Entra ID is configured for access, a **Sign-in**page appears in the portal, and users must sign in to access APIs. See [Enable sign-in to portal by Microsoft Entra users and groups](#enable-sign-in-to-portal-by-microsoft-entra-users-and-groups) for details on how to configure user access to the portal.
67
+
By default, the portal home page is publicly reachable. If Microsoft Entra ID is configured for access, users must select **Sign-in** to access APIs. See [Enable sign-in to portal by Microsoft Entra users and groups](#enable-sign-in) for details on configuring user access.
69
68
70
69
## Enable sign-in to portal by Microsoft Entra users and groups
71
70
@@ -76,12 +75,12 @@ By default, the portal home page is reachable publicly. If Microsoft Entra ID is
76
75
The following sections show you how to customize the API Center portal experience for users. For more extensive customization, you can also choose to [self-host the API Center portal](self-host-api-center-portal.md).
77
76
78
77
> [!IMPORTANT]
79
-
> Select **Save + publish**on the API Center portal's **Settings** page each time that you make changes to the settings. Until you publish, your changes aren't visible in the API Center portal.
78
+
> Select **Save + publish**after making changes. Changes aren't visible until published.
80
79
> :::image type="content" source="media/set-up-api-center-portal/save-and-publish.png" alt-text="Screenshot of Save + Publish button in the Azure portal.":::
81
80
82
81
### Site profile
83
82
84
-
On the **Site profile** tab of the API Center portal settings, optionally provide a custom name that appears in the top bar of the published portal.
83
+
On the **Site profile** tab of the API Center portal settings, optionally provide a custom name to appear in the top bar of the portal.
85
84
86
85
:::image type="content" source="media/set-up-api-center-portal/custom-name.png" alt-text="Screenshot of custom name in API Center portal.":::
87
86
@@ -90,18 +89,18 @@ On the **Site profile** tab of the API Center portal settings, optionally provid
90
89
On the **Visibility** tab, control which APIs are discoverable (visible) to API Center portal users. Visibility settings apply to all users of the API Center portal.
91
90
92
91
> [!NOTE]
93
-
> The API Center portal uses the [Azure API Center data plane API](/rest/api/dataplane/apicenter/operation-groups) to retrieve and display APIs in your API center, and by default shows all APIs for users with access.
92
+
> The API Center portal uses the [Azure API Center data plane API](/rest/api/dataplane/apicenter/operation-groups) to retrieve and display APIs in your API center. By default, it makes all APIs visible to users with access.
94
93
>
95
94
96
-
To make only specific APIs visible, add filter conditions for APIs based on built-in properties. For example, choose to display APIs only of certain types, like REST or GraphQL, or based on certain specification formats, such as OpenAPI.
95
+
To make only specific APIs visible, add filter conditions for APIs based on built-in properties. For example, display APIs only of certain types, like REST or GraphQL, or based on certain specification formats, such as OpenAPI.
97
96
98
97
:::image type="content" source="media/set-up-api-center-portal/add-visibility-condition.png" alt-text="Screenshot of adding API visibility conditions in the portal.":::
99
98
100
99
### Semantic search
101
100
102
101
If you enable semantic search on the **Semantic search** tab, the API Center portal supplements basic name-based API search with AI-assisted *semantic search* built on API names, descriptions, and optionally custom metadata. Semantic search is available in the **Standard** plan only.
103
102
104
-
Users can search for APIs by using natural language queries, making it easier to find APIs based on their intent. For example, if a developer searches for "I need an API for inventory management," the portal can suggest relevant APIs, even if the API names or descriptions don't include those exact words.
103
+
Users can search for APIs by using natural language queries to find APIs based on their intent. For example, if a developer searches for "I need an API for inventory management," the portal can suggest relevant APIs, even if the API names or descriptions don't include those exact words.
105
104
106
105
> [!TIP]
107
106
> When using the **Free** plan of Azure API Center, you can [upgrade](frequently-asked-questions.yml#how-do-i-upgrade-my-api-center-from-the-free-plan-to-the-standard-plan) to the **Standard** plan to enable full service features including semantic search in the API Center portal.
@@ -116,7 +115,7 @@ On the **Metadata** tab, optionally select [custom metadata](metadata.md) proper
116
115
117
116
## Enable access to test console for APIs
118
117
119
-
You can configure user settings to granularly authorize access to APIs and their specific versions in your API center. For example, configure certain API versions to use API keys for authentication, and create an access policy that permits only specific users to authenticate by using those keys.
118
+
You can configure user settings to granularly authorize access to APIs and specific versions in your API center. For example, configure certain API versions to use API keys for authentication, and create an access policy that permits specific users to authenticate by using those keys.
120
119
121
120
Access policies also apply to the "Try this API" capability for APIs in the API Center portal, ensuring that only portal users with the appropriate access policy can use the test console for those API versions. [Learn more about authorizing access to APIs](authorize-api-access.md).
122
121
@@ -125,4 +124,4 @@ Access policies also apply to the "Try this API" capability for APIs in the API
125
124
## Related content
126
125
127
126
*[Enable and view Azure API Center portal in Visual Studio Code](enable-api-center-portal-vs-code-extension.md)
128
-
*[Self-host the API Center portal](self-host-api-center-portal.md)
127
+
*[Self-host the API Center portal](self-host-api-center-portal.md)
0 commit comments