Developer Portal API Product Publication
Overview​
This tutorial walks you through the process of creating and publishing API Products on the Developer Portal. A Product in APIM groups together multiple APIs and allows you to define product-level metadata such as title, description, logo, and document links. Published products become visible to developers for discovery and usage.
Prerequisites​
- At least one deployed API available in your APIM Console
- Admin access to Admin > Product Management
Step-by-Step Tutorial​
Step 1. Create a New Product​
Navigate to Admin > Product Management, then click the plus button.
In the popup:
- Enter Product Name: sk01
- Click Confirm to proceed.
Step 2. Fill in Basic Product Information​
After creating the product, you’ll be redirected to the detail page.
| Field | Example |
|---|---|
| Name | sk01 (auto-filled) |
| Description | Authentication and user management API |
| Product Intro Link | https://developers.skapim.co.kr/product/sk01/overview |
| Enable Product Checked | (displayed on Developer Portal) |
| Enable API Document Link Checked | (activates API doc access in product detail page) |
| Product Icon | icon-sk01.png (1:1 ratio, 40x40px shown size) |
Click Save to save basic info.
Step 3. Add APIs to the Product​
Switch to the API tab in the product detail view.
Click the Add button to assign APIs to this product.
Available API Fields:
| Field | Example |
|---|---|
| Project | mj-test-kong |
| Gateway | mj-test-kong-gateway |
| API | testFromBff0052 |
| Description | helloworld2222 |
| Tags |
Click the check icon to finalize adding.
You can:
- Add multiple APIs
- Remove APIs (X icon)
- View or edit each API (gear or view icon)
Step 4. Activate Product on Developer Portal​
Back on the Product List, you’ll see your new entry.
| Column | Description |
|---|---|
| Checkbox | Toggle to publish or hide the product on Developer Portal |
| Order | Define the display order in the product list (0 = top) |
Click Save Order after editing display positions.
Best Practices​
- Keep product names meaningful and unique
- Use 1:1 ratio icons (40x40px) for consistent display
- Group related APIs into a single product for easy discovery
- Use the Product Intro Link to connect users to documentation or business overview
- Use tags for internal organization and frontend filters