|
1 | 1 | ---
|
2 |
| -title: Set up the API Center portal |
| 2 | +title: Set Up the API Center Portal |
3 | 3 | description: How to set up the API Center portal, a managed website that enables discovery of the API inventory in your Azure API center.
|
4 | 4 | author: dlepow
|
5 | 5 | ms.service: azure-api-center
|
6 | 6 | ms.topic: how-to
|
7 |
| -ms.date: 04/28/2025 |
| 7 | +ms.date: 04/30/2025 |
8 | 8 | ms.author: danlep
|
9 | 9 | ms.custom:
|
| 10 | +ms.collection: ce-skilling-ai-copilot |
10 | 11 | # Customer intent: As an API program manager, I want to enable an Azure-managed portal for developers and other API stakeholders in my organization to discover the APIs in my organization's API center.
|
11 | 12 | ---
|
12 | 13 |
|
@@ -62,7 +63,32 @@ To make only specific APIs visible, go to the **API visibility** tab in the API
|
62 | 63 |
|
63 | 64 | ## Enable access to test console for APIs
|
64 | 65 |
|
65 |
| -You can configure user settings to granularly authorize access to APIs and their specific versions in your API center. For example, you can configure certain API versions to use API keys for authentication, and create an access policy that permits only specific users to authenticate using those keys. This policy also applies 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) |
| 66 | +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 using those keys. This policy also applies 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) |
| 67 | + |
| 68 | +## API discovery and consumption in the API Center portal |
| 69 | + |
| 70 | +The API Center portal supports and streamlines the work of developers who use and create APIs within your organization. Signed-in users can: |
| 71 | + |
| 72 | +* **Search for APIs** by name or using [AI-assisted semantic search](#search-with-ai) |
| 73 | + |
| 74 | +* **Filter APIs** by type or lifecycle stage |
| 75 | + |
| 76 | +* **View API details and definitions** including endpoints, methods, parameters, and response formats |
| 77 | + |
| 78 | +* **Download API definitions** to a local computer or open them in Visual Studio Code |
| 79 | + |
| 80 | +* **Try out APIs** that support API key authentication or OAuth 2.0 authorization |
| 81 | + |
| 82 | +## Search with AI |
| 83 | + |
| 84 | +In the Standard plan of Azure API Center, the API Center portal supplements basic name-based API search with AI-assisted *semantic search* built on API names and descriptions. Users can search for APIs 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 their names or descriptions don't include those exact words. |
| 85 | + |
| 86 | +> [!TIP] |
| 87 | +> If you're using the Free plan of Azure API Center, you can [upgrade easily](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. |
| 88 | +
|
| 89 | +To use AI-assisted search when signed in to the API Center portal, click in the search box, select **Search with AI**, and enter a query. |
| 90 | + |
| 91 | +:::image type="content" source="media/set-up-api-center-portal/semantic-search.png" alt-text="Screenshot of semantic search results in API Center portal."::: |
66 | 92 |
|
67 | 93 | [!INCLUDE [api-center-portal-compare-apim-dev-portal](includes/api-center-portal-compare-apim-dev-portal.md)]
|
68 | 94 |
|
|
0 commit comments