Products
Create and publish a product
Create a product, set its Details, add a plan and set it Active, then switch the product to Active to publish it in your API Portal.
You build a product in the dashboard, set who can see it on its Details tab, give it at least one Active plan, then switch the product itself to Active to publish it. The product appears in your API Portal once it is Active with an active plan.
How do I create a product?
Open Products then API Products in the dashboard, add a product, and give it a name. The product opens on its Details tab, where you fill in the rest and save.
- Go to Products, then API Products.
- Add a product and type its name in the header.
- Fill in the Details tab (below).
- Click Save Changes in the product header.
The product is listed under API Products. Saving creates it; it is not published yet, because publishing needs an active plan.
What do I set on the Details tab?
The Details tab holds the product's name, slug, categories, visibility, audience, description, and card presentation. These control how the product is identified and who can reach it in your API Portal.
| Field | What it sets |
|---|---|
| Title | The product's display title. |
| Slug | The product's URL segment, shown as your-portal/products/{slug}. It must be unique across your products. |
| Product Categories | The categories that group this product in the catalog. See Product categories. |
| Visibility | Open or Hidden. Open lists the product in your API Portal catalog; Hidden keeps it off the listing. |
| Audience | Public, Manual, or Internal. Public is open to portal visitors; Manual and Internal restrict who can reach the product. |
| Description | The longer description shown with the product. |
| Product Card Display | Whether the catalog card shows the product's Icon or its Image. |
| Icon | The icon used on the product card. |
| Image | The image used on the product card. |
The Slug field rejects a value already used by another product and shows which product holds it, so pick a unique slug.
How do visibility and audience work together?
Visibility lists or hides the product; audience sets who can reach it. When you set the audience to anything other than Public, Apiable forces visibility to Hidden and disables the Open option.
- Audience Public leaves both Open and Hidden selectable for visibility.
- Audience Manual or Internal forces Visibility to Hidden and disables Open, because a non-public product is not listed publicly.
To list a product for all portal visitors, set Audience to Public and Visibility to Open.
How do I add a plan and set it Active?
Open the product's API Plans tab, add a plan, configure it, then set its status to Active. The product cannot be published until at least one of its plans is Active.
- Open the product and select the API Plans tab.
- Add a plan and configure it across its tabs. See Anatomy of a plan and Add APIs and choose coupling.
- Set the plan to Active from its Publish tab.
A product can hold several plans, for example a free tier and a paid tier. Only one of them needs to be Active for the product to be publishable.
How do I publish the product?
Switch the product's header toggle from Inactive to Active, then click Save Changes. The toggle stays disabled until the product has at least one plan with status Active.
- Confirm the product has a plan with status Active.
- In the product header, switch the toggle to Active.
- Click Save Changes.
Once the product is Active with an active plan, and its visibility and audience allow it, the product appears in your API Portal.
Troubleshooting
The product page blocks publishing and editing in specific cases. Match what you see to the fix.
| What you see | What to do |
|---|---|
| The Active toggle is disabled and hovering it says a product cannot be published without an active plan | Add a plan on the API Plans tab and set it Active, then switch the product to Active. |
| The Active toggle is disabled and hovering it says your role is insufficient | Your account lacks the role to publish products. Ask an administrator for the role that publishes products. |
| A banner reads that your account does not have a sufficient role to edit this product | Your role cannot edit products. The fields are read-only until you have the editing role. |
| The Slug field shows that the slug is already in use by another product | Choose a unique slug; the message names the product currently using it. |
| Visibility will not switch to Open | The Audience is Manual or Internal, which forces Hidden. Set Audience to Public to enable Open. |
| The Delete button in the Danger Zone is disabled | The product still has plans. Remove its plans first, then delete the product. |
Where to next
Product categories
Create categories and group products in your API Portal catalog.
Product marketing and menu
The Product Overview page, Menu Items, and the Features comparison table.
Anatomy of a plan
The plan tabs, the plan lifecycle, and when to create a new version.
Add APIs and choose coupling
Add APIs to a plan and choose Gateway-bound or Catalog-bound.