Create and publish a product

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, choose Add another Product, and give it a name. The product opens on its Details tab, where you fill in the rest and save.

1. Go to Products, then API Products.
2. Choose Add another Product and type the product's name in the header.
3. Fill in the Details tab (below).
4. Choose 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 title, slug, categories, visibility, audience, description, and card presentation. These control how the product is identified and who can reach it in your API Portal.

The Slug field rejects a value already used by another product and names that product, 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 OPEN.

• 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 publish it?

Open the product's API Plans tab, create a plan, configure it, then publish it from its Publish tab. The product cannot be published until at least one of its plans is Active.

1. Open the product and select the API Plans tab.
2. Choose + Create Plan, or Create a new plan if the product already has plans.
3. Configure the plan across its tabs. See Anatomy of a plan and Add APIs and choose coupling.
4. On the plan's Publish tab, choose Confirm & Publish this version, then Publish version. The plan becomes Active.

If Confirm & Publish this version is disabled, hover it to see what the plan still needs. See Why can't I publish or activate this plan?.

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 choose Save Changes. The toggle stays disabled until the product has at least one plan with status Active.

1. Confirm the product has a plan with status Active.
2. In the product header, switch the toggle to Active.
3. Choose 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.

How do I delete a product?

From the Danger Zone at the bottom of the Details tab, which shows only if your role can remove products. Choose Delete, then confirm. A product that still has plans cannot be deleted.

1. Open the product's Details tab and scroll to the Danger Zone.
2. Choose Delete.
3. In the Delete Product confirmation, choose Delete.

If the product has plans, the confirmation's Delete is disabled and explains that you must delete the plans first. Deleting a product cannot be undone.

Troubleshooting

The product page blocks publishing and editing in specific cases. Match what you see to the fix.

Where to next