Developer Portal in Azure API Management
Overview
The Developer Portal is a powerful self-service website that serves as the central hub for external developers to discover, explore, test, and subscribe to your APIs. Think of it as your API's storefront - it's often the first impression developers have of your API platform. A well-designed developer portal can significantly increase API adoption and developer satisfaction.
What You'll Learn
- What the developer portal offers to both API consumers and publishers
- How to customize the portal with your branding
- Managing user registration and approval workflows
- Understanding the API key subscription process
Why the Developer Portal Matters
The developer portal transforms how external developers interact with your APIs by providing:
- Self-service onboarding - Developers can sign up and get started without contacting your team
- Interactive documentation - Try APIs directly in the browser without writing code
- API key management - Easy subscription and key generation
- Code generation - Ready-to-use code snippets in multiple programming languages
Access the Portal
Default URL
https://my-apim.portal.azure-api.net
Link from Azure Portal
- Go to APIM
- Click Developer portal in menu
Features for Developers
| Feature | Description |
|---|---|
| API Catalog | Browse available APIs |
| Documentation | Interactive API docs |
| Try It Out | Test APIs directly |
| Subscribe | Get API keys |
| Code Samples | Example code in multiple languages |
Features for Publishers
| Feature | Description |
|---|---|
| Customize Branding | Logo, colors, content |
| Add Content | Tutorials, guides |
| Manage Users | Approve/deny sign-ups |
| Analytics | See who's using portal |
Customize the Portal
Basic Branding
- Go to Developer portal → Identity
- Configure:
- Logo
- Primary color
- Headline
- Footer content
Edit Pages
- Navigate to page to edit
- Click Edit in menu
- Modify content
- Click Publish
User Registration
Default: Open
- Anyone can sign up
- Auto-approved
Change to Approval
- Go to Developer portal → Settings → User
- Enable Require user approval
Manage Users
- Go to APIM → Users
- View, approve, or block users
API Key Workflow
- Developer signs up
- Developer browses APIs
- Developer subscribes to product
- Developer gets subscription key
- Developer calls API with key
Next Steps
- Learn about APIM Tiers Overview
Azure Integration Hub - Beginner Level