Set up your portal: the onboarding plan

Setting up an API Portal runs in six phases, from configuring the portal to publishing content. Each phase unblocks the next, so working in order avoids rework. This page is the map; each phase links to the guide that walks it.

In what order should you set up your portal?

Work through six phases: Settings, Organization, Portal content, Products, Integrations, then Content. Settings and accounts come first, products and integrations next, and content last, because each phase depends on the ones before it.

Who sets up an API Portal?

Apiable has five assignable roles. You assign them in phase two, then each role owns the phases that match it. Settings and accounts sit with the admins; products and content with the Product Owner; gateway and payment with the Configuration Owner.

Phase 1: How do you configure portal settings?

Set the portal's identity and access rules first. Configure the portal name and registration, then restrict access and turn on the security you need. These settings frame every page a developer sees.

1. Set the portal name, registration approval, and any extra sign-up fields.
2. Add your marketing and SEO details, such as Google Tag Manager and Open Graph tags.
3. Connect a custom domain if you serve the portal on your own URL.
4. Set portal security, including restricted access and multi-factor authentication.

Phase 2: How do you set up accounts and roles?

Create the accounts your team needs and assign each one a role. Add the groups that govern access and approvals. This phase decides who can own the later phases.

1. Create an account for each team member.
2. Assign one of the five roles to each account.
3. Set up the groups that control access and the groups that approve requests.

Phase 3: How do you set up portal content and presentation?

Prepare the pages developers land on and the look around them. Review the core pages, theme the portal, and arrange the header and footer menus.

1. Review and fill in your core pages, such as about, terms, contact, and privacy.
2. Theme the portal: logo, colours, typography, and the landing page.
3. Arrange the header and footer navigation.

Phase 4: How do you build products and plans?

Create the products developers subscribe to and the plans that set their access and price. A plan bundles APIs, sets the access level, and carries any rate limits and pricing.

1. Create a product and write its presentation.
2. Add plans, and on each plan choose the APIs and the coupling.
3. Set the plan's security level, rate limits, and pricing.

Phase 5: How do you connect integrations?

Connect the systems that enforce and bill access. Link your API gateway so plans map to real APIs, and connect Stripe so paid plans can charge.

1. Connect your API gateway, such as AWS API Gateway, Azure, Kong, or Apigee.
2. Connect Stripe as your payment provider.
3. Confirm plans resolve to the right gateway APIs.

Phase 6: How do you publish content?

Write the content developers need and publish it. Add articles and API documentation, organise them with tags and collections, then set each page's visibility.

1. Write articles and attach API documentation to your plans.
2. Organise content with tags and collections.
3. Publish each page with public or login-required visibility.

Where to next