Products
Products
A product bundles your APIs into plans that developers subscribe to in your API Portal. You set its visibility, audience, and publish it once it has an active plan.
A product bundles your APIs into plans that developers subscribe to in your API Portal. You build it once in the dashboard, set who can see it, and publish it when it has an active plan.
What is a product in Apiable?
A product is the package a developer browses and subscribes to. It groups one or more APIs into plans, carries its own marketing page and categories, and appears in your API Portal once published. In the dashboard, products are listed under API Products.
How does a product bundle APIs into plans?
A product holds plans, and each plan defines the APIs, access, limits, and price for one tier. You add plans on the product's API Plans tab, then open a plan to configure it. One plan belongs to exactly one product.
| Level | What it defines |
|---|---|
| Product | The package developers see: name, marketing page, categories, visibility, audience. |
| Plan | One tier inside the product: its APIs, access control, security, limits, and price. |
A product with several plans gives developers tiers to choose between, for example a free tier and a paid tier of the same APIs.
What do visibility and audience control?
Visibility sets whether the product is listed in your API Portal. Audience sets who can reach it. The two are set on the product's Details tab and work together.
| Setting | Options | What it does |
|---|---|---|
| Visibility | Open, Hidden | Open lists the product in your API Portal. Hidden keeps it off the public listing. |
| Audience | Public, Manual, Internal | Public is open to portal visitors. Manual and Internal restrict who can reach the product. |
When you set the audience to Manual or Internal, visibility is forced to Hidden and Open is disabled, because a non-public product is not listed publicly.
How do I publish a product?
Set its Active toggle in the product header. The toggle stays disabled until the product has at least one plan with status Active, so add and activate a plan first.
- Open the product and go to its API Plans tab.
- Add a plan and configure it (see the plan pages below).
- Set that plan's status to Active.
- Back in the product header, switch the product to Active.
Until an active plan exists, hovering the disabled toggle shows that a product cannot be published without an active plan.
What does a product organize besides plans?
Beyond plans, a product carries a marketing page, menu items, and categories that group it in your API Portal. These are configured on the product's other tabs: Product Overview, Menu Items, and Features Table, with categories set on Details.
For the catalog, theming, and navigation of the portal itself, see API Portal.
Where to next
Create and publish a product
Set details and visibility, add a plan, and publish.
Product categories
Group products into catalog categories in your API Portal.
Product marketing and menu
The product overview page, menu items, and features table.
Anatomy of a plan
The plan tabs, lifecycle, and the plan setup pages.