API Experience

The API Experience section helps you select and customize the right developer portal solution for your business needs. Choose between essential branding and quick setup or advanced enterprise features

Helix provides flexible portal solutions tailored to different organizational requirements:

• Basic Dev Portal: Ready-to-use portal with essential features and light branding for rapid deployment

• Advanced API Experience (Enterprise): Full-featured portal with monetization, advanced security, and sandboxing capabilities

• Live Examples: Explore real developer portals powered by Helix to see these experiences in action

Basic Dev Portal

The Basic Dev Portal is ideal for organizations that need a functional, branded API portal without complex monetization or sandboxing requirements.

Key Features

• Branding Support: Customize logos and primary colors while maintaining a consistent, maintainable layout

• Access Controls: Manage permissions for partner and vendor integrations with straightforward role management

• Developer Experience: Provide intuitive access for internal teams or public API consumers to discover and use your APIs

• Landing Page Customization: Upload custom HTML landing pages for complete branding flexibility

Example Use Cases

• Internal API programs requiring branded documentation and discovery

• Public-facing API initiatives that don't require monetization

• Rapid deployment scenarios where time-to-market is critical

• Organizations with limited technical resources for portal maintenance

Advanced API Experience (Enterprise)

The Advanced API Experience is designed for enterprises requiring comprehensive developer portals with full monetization, security, and customization capabilities.

Key Features

• Monetization: Integrated billing, subscription management, and revenue tracking with flexible pricing models

• Advanced Sandboxing: Provide isolated testing environments for developers to safely experiment with APIs

• Enterprise Security: Role-based access controls, advanced authentication, and comprehensive audit trails

• Full Branding Customization: Complete control over visual design, layout, and user experience

• Advanced Analytics: Detailed usage dashboards, performance metrics, and business intelligence integration

• Marketplace Features: Curated API products, developer onboarding workflows, and partner management

Example Use Cases

• Public API marketplaces with monetization requirements

• Enterprises needing strict security and compliance controls

• Organizations with complex partner ecosystems requiring granular access management

• Businesses launching comprehensive API programs with multiple consumer segments

Feature Comparison

Feature	Basic Dev Portal	Advanced API Experience
Branding	Logo & primary colors	Full branding customization
Access Control	Basic partner/vendor integrations	Enterprise-grade, role-based access controls
Monetization	Not available	Billing & subscription management
Sandboxing	Not available	Isolated testing environments
Analytics	Basic usage metrics	Advanced analytics dashboards
Customization	Landing page upload	Complete UI/UX customization
Security	Standard authentication	Advanced security policies & compliance
API Products	Basic grouping	Full product management & curation

This comparison helps you select the appropriate developer portal based on your specific requirements, balancing essential features with advanced enterprise capabilities.

Upload Landing Page

Customize your Basic Dev Portal by replacing the default landing page with a fully branded HTML experience.

Overview

• Purpose: Replace the default landing page with a custom HTML design that reflects your brand identity

• Flexibility: Maintain complete control over layout, messaging, and visual design while leveraging Helix's core functionality

• Fallback Option: Revert to the default template at any time with a single click

Upload Process

1. Drag & Drop

2. Drag your .zip file containing the HTML landing page and all associated assets directly into the upload area

3. Browse File

4. Click Browse File to select a .zip file from your local system

File Requirements

• Accepted File Type: .zip only

• Maximum File Size: 10 MB

• Required Structure: Must include index.html as the entry point

Landing Page Management

• Upload Status: View file name and activation status (e.g., Status: Enabled) confirming the custom page is live

• Use Default Template: Instantly revert to the original Helix landing page when needed

• Download Template: Access the default template as a starting point for your custom designs

UI Customisation

Tailor the visual design of your developer portal to create a cohesive brand experience that engages developers and reinforces your organization's identity.

Overview

• Purpose: Ensure consistent brand identity and professional appearance across all portal pages

• Flexibility: Update visual elements without affecting core portal functionality or requiring technical resources

• Target Users: Organizations seeking a polished, branded API experience that builds developer trust and engagement

Customisation Options

Logo Management Upload your organization's logo for display in the portal header and navigation

• Drag & Drop: Drag a .png, .jpg, or .jpeg file directly into the upload area

• Browse File: Select a logo file from your local system

• File Requirements:

• Accepted Formats: .png, .jpg, .jpeg

• Maximum Size: 2 MB

• Recommended: High-resolution logo with transparent background

Favicon Customisation Add a custom favicon that appears in browser tabs and bookmarks

• Drag & Drop: Drag a .ico file into the designated upload area

• Browse File: Select a favicon file from your local system

• File Requirements:

• Accepted Format: .ico only

• Maximum Size: 1 MB

• Recommended: 16x16 or 32x32 pixel square format

Theme Customisation

Comprehensive control over the portal's visual appearance to match your brand guidelines

• Color Scheme: Define primary, secondary, and accent colors that reflect your brand palette

• Typography: Customize fonts, sizes, and spacing for optimal readability and brand consistency

• Layout Elements: Adjust visual elements to create a unique, branded experience

• Brand Consistency: Ensure unified look and feel across all portal pages and components

Enhanced UX: Improve usability and developer engagement through thoughtful visual design