API Portal
Navigation
Configure the header and footer menus of your API Portal. Add items that link to a page or an external URL, drag to reorder, and toggle each item active or inactive.
The portal navigation is the set of menus developers use to move around your API Portal. You edit it under Portal, Navigation. A Main Navigation tab controls the header, and a Footer Navigation tab controls the footer. Each item links to a portal page or an external URL.
Which menus can you configure?
Two menus, on two tabs. Main Navigation is the header menu at the top of the portal. Footer Navigation is the footer menu at the bottom. Each tab lists that menu's items with their name, slug, and status.
| Tab | Menu |
|---|---|
| Main Navigation | The header menu across the top of the portal. |
| Footer Navigation | The footer menu at the bottom of the portal. |
How do you add a navigation item?
Choose Add New to open the item modal. Enter a Name, then pick a published page from the Pages table, or turn on Use external link and enter a URL. Choose Save to add it to the menu.
- On Main Navigation or Footer Navigation, choose Add New.
- Enter a Name for the menu item.
- Pick a page from the Pages table, or turn on Use external link and enter the Link URL.
- Set the Public toggle if you want the item visible to unauthenticated visitors.
- Choose Save.
How do you link to an external site?
In the item modal, turn on Use external link and enter the address in the Link field. Apiable checks that the URL is a valid format. Leave the toggle off to link to one of your portal pages from the Pages table instead.
How do you reorder navigation items?
Drag an item by the handle on the left into the order you want, then choose Save Order. The order on screen becomes the order on the portal once you save. Save Order is available once the order has changed.
- Drag an item by its handle to a new position.
- Repeat until the order is right.
- Choose Save Order.
How do you show or hide an item?
Use the toggle in the item's Status column. Active shows the item on the portal. Inactive keeps it in the list but hides it from the portal. Toggle it back to Active to show it again.
How do you edit or delete an item?
Open the row menu on an item and choose Edit to reopen its modal, or Delete to remove it. Items that point to protected slugs cannot be deleted, so core portal pages stay reachable.
Troubleshooting
| What you see | What to do |
|---|---|
| Save stays disabled in the modal | Enter a Name and either pick a page or enter a valid external Link. All three are required to save. |
| The external link shows a URL error | The Link is not a valid URL format. Enter a full address, for example one that starts with https://. |
| A page is missing from the Pages table | The page is not published. Publish it under Portal, Pages, then reopen the modal. |
| Save Order stays disabled | The order has not changed yet. Drag an item to a new position to enable it. |
| Delete is disabled on an item | The item points to a protected slug. It cannot be deleted; toggle it inactive instead if you want it hidden. |