How-to Guides
Learn how to use Helix's core capabilities effectively.
Manage API Environments
The API Environments page lets you connect, configure, and oversee all your API gateway instances from a single location.
Key Features
Usage overview
API & Gateway Usage Overview: Monitor your current API usage (APIs Left out of total quota) and gateway instance availability (Gateway Left out of total quota).
Add API Gateway
Add New Gateway Instance: Quickly connect a new gateway instance. Supported gateways include:
Apigee X
AWS
Azure
HELIX
Kong
Mulesoft
Coming Soon: SAP / SAP S4/HANA, IBM API Connect, Tyk, WSO2, Layer 7
Manage existing gateway instance
Manage Existing Instances: View all connected gateways in a table. For each instance, you can see its name, status, and last updated timestamp. Available operations include:
Sync API: Synchronize APIs from the gateway
Import iFlow/API: Import APIs or flows
Edit: Update the gateway configuration
Delete: Remove the instance
Filtering & Searching: Filter instances by business domain or search for a specific gateway.
Manage API Sources
Centralizes the connection and management of sources for your API artifacts.
Supported Sources
Postman Collections: Import collections to seed new APIs or update existing ones.
GitHub: Use GitHub Actions to publish API changes directly to Helix.
SwaggerHub Import: Use SwaggerHub Actions to publish API updates.
Coming Soon: Bitbucket: Integrate with Bitbucket pipelines to publish API changes.
Manage API Estate
The API Estate page is a unified interface to organize, monitor, and manage all APIs across your organization.
Key Features
API Cards Overview: View each API as a card showing its name, description, access type, version, and tags.
Search and Filters: Find APIs by name or keyword. Filter by access type or other advanced criteria.
Views: Switch between Grid, List, and Table views.
API Operations:
View Details: See endpoints, specifications, and activity.
Create New API: Add a new API.
Version Management: Select or switch API versions directly from the card.
Status Indicators: Use icons to identify operational status.
Create an API
Use the Create API page to add a new API to your estate.
Procedure
API Name: Enter a unique internal identifier.
Display Name: Provide a user-friendly name.
Version: Specify the API version.
Contract Specification Type: Select OAS3 or OAS2.
Business Area: Categorize the API.
Description: Provide a brief summary.
Tags: Optional tags for search and categorization.
Upload Documentation: Attach a .zip file (max 10 MB).
Final Steps
Click Create to add the API to your estate.
Click Cancel to exit without saving.
API Details Overview
Selecting an API from the API Estate opens a comprehensive details page with multiple tabs.
Overview Tab
API Identity: Name, access type, and version
Management Controls: Edit Details, Edit Publication Settings, More Actions
Key Metrics: Average User Rating, API Gateway info, Total Subscriptions, Churn Rate, Performance data (Last 7 Days)
Documentation Tab
API documentation in markdown format with release notes
AI-powered documentation generation
Download capability
Metadata Tab
Key-value pairs showing API configuration (e.g., apiName, apiVersion, businessLine, region)
Test this API Tab
Interactive API testing with language selection, endpoint search, request configuration, and mock environments
Specification Tab
API contract viewing and download options, version history tracking
Governance Dashboard Tab
Compliance Center: Documentation completeness, metadata compliance, OWASP vulnerabilities, linting tests
Security Center: Security scans, OWASP tests, linting rule compliance
AI Affinity: Similarity detection, duplicate API identification
Analytics: Operational metrics, performance charts, security results
Manage API Products
Product Actions
Search: Quickly find products by name or keyword
Filters: Filter products by access type or tag
Pagination: Navigate through pages when multiple products exist
View Details: Click a product to see the APIs it contains, version history, and metadata
Create an API Product
The Create Product page allows you to define a new API Product and bundle APIs into it. This ensures proper governance, version control, and documentation from the outset.
Procedure
Product Name Enter a unique internal identifier for the product.
Display Name Provide a user-friendly name visible in the developer portal.
Version Specify the version of the product for proper lifecycle management.
Business Area Select the business area for categorization. The default business area can be preselected.
Tags Optionally, add tags to simplify search and classification.
Description Provide a summary of the product's purpose and the APIs it includes.
Upload Documentation Attach supporting documentation to the product:
Drag & Drop: Drag files into the upload area
Browse File: Select a file from your system
Accepted File Type: .zip only
Maximum File Size: 10 MB
Select API Content Choose which APIs to include in this product from the available list:
Search APIs: Locate APIs by name or keyword
Select All: Quickly include all APIs in the product
Individual Selection: Pick specific APIs by version
Final Steps
Click Create to finalize and add the product to your API Products list
Click Cancel to exit without creating the product. All entered information will be discarded
Taxonomies
Helix provides centralized classification and tagging of APIs and events to organize your digital estate and enforce governance.
Key Features
Hierarchical Taxonomy Structure: Define Business Areas, Lines, Domains, and Capabilities.
Tagging: Assign tags to APIs, events, and gateways for easier search and filtering.
Automated Suggestions: AI suggests tags and categories based on metadata, contracts, and usage patterns.
Governance Enforcement: Ensure all APIs comply with organizational taxonomy rules before publication.
Last updated