Note
Your ability to create, edit, and view products on this page is tied to your role assignment in API Hub for Design. Learn more here.
To create a new product:
On the home screen, select Manage Products or the cog in the Products section.
Click Add Product.
Enter the name of the product.
Specify the product URL.
Select if you want to create an empty product or start from a template. The default template should already be selected if set.
Click Create Product.
The new product is created and added to the product list.
You can go to the live view from:
Home screen.
Portal configuration page.
Product content page.
Product settings page.
To go to the live view:
Select Portal Live View on your home screen.
Select Live View on the rest of the above pages.
Note
You cannot edit pages, or configure the portal or products in the consumer view.
You can apply changes to:
Portal settings
Product settings
To apply changes:
Select Apply Changes.
Select Confirm.
The latest changes are applied.
To open account settings:
Select the account button.
In the modal window, select Manage My Account.
SmartBear ID opens in a new browser tab.
To enter a product name:
On the home screen, select Manage Products or the cog in the Products section.
In the Product Name section, select the Product Name text field.
Enter the desired product name.
The product name is updated.
Note
The maximum length of the product name is 22 characters.
To set the product URL:
On the home screen, select Manage Products or the cog in the Products section.
In the Product URL section, select Edit.
In the pop-up window, enter the desired product URL in the text field.
The product URL is updated.
To create or edit a product description:
On the home screen, select Manage Products or the cog in the Products section.
Choose the product from the list of products on the left.
In the Product Description section, select the Product Description text field.
Enter the product description.
Note
The maximum length of the product description is 110 characters.
Click Apply Changes.
The product description is updated.
To set the product logo:
On the home screen, select Manage Products or the cog in the Products section.
In the Product Logo section, select Upload.
In the pop-up window, select an image file.
Select Open.
The product logo is updated.
To set the product visibility:
On the home screen, select Manage Products or the cog in the Products section.
In the Product Visibility section, select the radio button that corresponds to the desired visibility.
For a private product, select the toggle switch to set whether you want to show the product on the landing page.
The product visibility is updated.
Caution
Public products can contain private APIs. If a public product contains a private API, that private API is visible to everyone even if they are not given specific permissions at the organization or product level in API Hub for Design.
You are responsible for tracking the exposure of private APIs in your public products.
Note
Private products can only be accessed by members of the connected API Hub for Design organization. Ensure the relevant users are added to the API Hub for Design organization and have the organization-level or product-level role of consumer. Learn more here.
It allows you to see the live preview of the product tile on the landing page. Read more about it here.
Delete a product to:
Delete every documentation page from the product.
Unlink every API from the product.
Delete the active product from API Hub for Portal.
To delete a product:
On the home screen, select Manage Products or the cog in the Products section.
Choose the product to be deleted and select Delete Product at the bottom of the page.
Enter the product name to confirm product deletion.
Select Delete.
The product is permanently deleted from the product list.