API Portal
API Portal
The API Portal is the branded developer site Apiable hosts for your APIs. You build it in the dashboard: pages, theme and navigation under Portal, and the portal's settings, from registration and domain to email and custom CSS, under Settings, Portal settings.
The API Portal is the developer-facing website Apiable hosts for your APIs. It carries your branding, presents your product catalog, and is where developers sign up, subscribe and get credentials. You build it in the dashboard.
What is the API Portal?
Your branded developer site. It lists your API products, runs registration and subscriptions, and serves your pages and documentation. Apiable hosts it, and you control its content, look, menus and settings from the dashboard.
What can you configure on the API Portal?
Three editors under Portal in the dashboard sidebar, and ten entries under Settings, Portal settings. Settings is at the bottom of the sidebar. Some entries depend on your plan.
| Area | What it controls | Where |
|---|---|---|
| Pages | Content pages, the landing pages and the Product Page | Portal, Pages |
| Theme | Colours, fonts, buttons, code blocks, landing page texts, email branding | Portal, Theme |
| Navigation | Header and footer menus | Portal, Navigation |
| Portal details and registration | Portal name, sign-up approval, registration fields, support email | Portal settings, Portal details |
| SEO and marketing | Portal title, meta tags, Google Tag Manager | Portal settings, Marketing |
| Custom domain | Serving the portal on your own domain | Portal settings, Domains |
| Security and MFA | A password prompt for the whole portal, and multi-factor authentication | Portal settings, Security |
| Custom CSS and Markdoc partials | Your own stylesheet, and content blocks reused across products | Portal settings, Custom CSS and Markdoc Partials |
| API spec viewer and validation | The API reference viewer, and Spectral validation of specs | Portal settings, API Specification and API Validation |
| Email domain and templates | The address portal email comes from, notification templates, contact form | Portal settings, Email Sender Identity and Templates |
Markdoc components lists the tags you use in pages, and Portal localization covers the language of the portal's built-in text.
Where does the portal's documentation content come from?
From the Content group in the dashboard sidebar. API Reference, Articles, Collections, Documentation and Media Repository publish documentation and articles to the portal alongside your pages. See Content.
Who can change the portal?
Pages, theme, navigation and most portal settings are edited by the Organisation Owner, Organisation Admins and Portal Admins. Renaming the portal needs the Organisation Admin role. See Members and roles for the full role list.
How do you start building the portal?
Set your brand first, then the pages, then the menus and settings. A typical order:
- Under Settings, Portal settings, Security, turn on Password protection to keep the portal out of view while you work.
- Under Portal, Theme, set your logo, colours, fonts and landing page texts.
- Under Portal, Pages, edit the Landing Page and Mobile Landing Page, and add your own pages.
- Under Portal, Navigation, arrange the header and footer menus.
- Under Portal settings, Portal details, set sign-up approval and the registration form.
- Add your domain under Domains, then turn Password protection off when you launch.
Where to next
Portal pages
Create, edit, and publish pages, including the landing pages.
Theme
Set colours, fonts, buttons, landing page texts, and email branding.
Navigation
Arrange the header and footer menus.
Portal details and registration
Set the sign-up fields, approval flow, and support email.
Custom domain
Serve the portal on your own domain.
Portal security and MFA
Put a password prompt in front of the portal and set MFA.