> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apinizer.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Portal

> API Portal, the component in the Apinizer platform that provides user interface for developers to discover APIs, review documentation, test, and use them. Apinizer API Developer Portal is a customizable platform that enables developers, business units, and your business partners to easily discover and use your APIs. The portal provides all the tools you need to securely share, document, and manage your APIs.

## API Portal Concept

<CardGroup cols={2}>
  <Card title="API Discovery" icon="magnifying-glass">
    Discovering API catalog
  </Card>

  <Card title="Documentation" icon="book">
    Detailed API documentation
  </Card>

  <Card title="Testing" icon="flask">
    Testing APIs
  </Card>

  <Card title="Self-Service" icon="user-gear">
    User self-service management
  </Card>
</CardGroup>

## Advantages Provided by Apinizer Developer Portal

<CardGroup cols={3}>
  <Card title="For Business Units" icon="building">
    * Accelerate inter-system integration by sharing your APIs with internal teams
    * Prevent information fragmentation by collecting technical documentation in a central location
    * Reduce support team workload with self-service approach
  </Card>

  <Card title="For Developers" icon="code">
    * Easily find the API you need and start using it immediately
    * Spend less time understanding the API with interactive documentation
    * Test safely in sandbox environment, make sure before going to production
  </Card>

  <Card title="For Business Partners" icon="handshake">
    * Provide secure access to your APIs
    * Manage and control your partner ecosystem
    * Strengthen your collaboration with transparent usage metrics
  </Card>
</CardGroup>

## API Portal Features

### API Discovery

<AccordionGroup>
  <Accordion title="API Catalog">
    * Listing all APIs
    * Category-based filtering
    * Search functionality
    * API detail pages
  </Accordion>

  <Accordion title="API Documentation">
    * OpenAPI/Swagger documentation
    * Endpoint details
    * Request/Response examples
    * Schema definitions
  </Accordion>

  <Accordion title="API Versions">
    * Version list
    * Version comparison
    * Deprecation information
  </Accordion>
</AccordionGroup>

### Self-Service Management

<CardGroup cols={2}>
  <Card title="Application Management" icon="mobile-screen-button">
    * Creating applications
    * Editing applications
    * Subscribing to API products
  </Card>

  <Card title="API Key Management" icon="key">
    * Creating API Keys
    * API Key rotation
    * Revoking API Keys
  </Card>

  <Card title="Usage Monitoring" icon="chart-line">
    * API usage statistics
    * Quota status
    * Error logs
  </Card>

  <Card title="Profile Management" icon="user">
    * User profile
    * Notification preferences
    * Account settings
  </Card>
</CardGroup>

### Testing and Trial

<AccordionGroup>
  <Accordion title="Interactive API Console">
    * Testing API endpoints
    * Sending requests
    * Viewing responses
    * Testing authentication
  </Accordion>

  <Accordion title="Code Snippets">
    * Code examples for various programming languages
    * cURL examples
    * SDK examples
  </Accordion>
</AccordionGroup>

### Customization

<CardGroup cols={2}>
  <Card title="Theme and Branding" icon="palette">
    * Logo and colors
    * Custom CSS
    * Branding
  </Card>

  <Card title="Language Support" icon="language">
    * Multi-language support
    * Localization
  </Card>

  <Card title="Custom Pages" icon="file-code">
    * Custom HTML pages
    * Content management
  </Card>

  <Card title="Integration" icon="plug">
    * SSO integration
    * Custom authentication
  </Card>
</CardGroup>

## Core Features

<CardGroup cols={2}>
  <Card title="Flexible Deployment" icon="server">
    Installation in on-premise or cloud environments for both internal and external APIs
  </Card>

  <Card title="Multiple API Specification Support" icon="file-code">
    OpenAPI (Swagger), WSDL, and custom documentation formats
  </Card>

  <Card title="Customizable Content" icon="pencil">
    Creating rich content with markdown at site level and API level
  </Card>

  <Card title="Self-Service Management" icon="user-gear">
    Developers managing their own API keys and subscriptions
  </Card>

  <Card title="Advanced Search and Filtering" icon="magnifying-glass">
    Quick search and category-based filtering in API catalog
  </Card>

  <Card title="Responsive Design" icon="mobile-screen-button">
    Modern interface that works seamlessly on all devices
  </Card>

  <Card title="Security and Authorization" icon="shield">
    Role-based access control and permission management at API level
  </Card>
</CardGroup>

## API Portal Usage Scenarios

<CardGroup cols={3}>
  <Card title="API Discovery" icon="magnifying-glass">
    1. Logging into Portal
    2. Reviewing API catalog
    3. Finding relevant API
    4. Reading documentation
    5. Testing
  </Card>

  <Card title="Application Creation" icon="mobile-screen-button">
    1. Creating new application
    2. Subscribing to API products
    3. Getting API Key
    4. Starting to use API
  </Card>

  <Card title="API Testing" icon="flask">
    1. Selecting API endpoint
    2. Entering request parameters
    3. Adding authentication information
    4. Sending request
    5. Reviewing response
  </Card>
</CardGroup>

## API Portal and API Manager Relationship

API Portal receives API information from API Manager and presents it to users. Workflow:

```
API Manager
   │
   │ API Configuration
   │ API Documentation
   │
   ▼
API Portal
   │
   │ User Interface
   │
   ▼
API Consumers (Developers)
```

<CardGroup cols={3}>
  <Card title="1. API Management" icon="gear">
    API Proxies are created and configured in API Manager

    API configurations and documentation are managed in API Manager.
  </Card>

  <Card title="2. Portal Integration" icon="globe">
    API information is transferred to API Portal

    API Proxies and documentation are displayed in portal.
  </Card>

  <Card title="3. Developer Access" icon="users">
    Developers discover and use APIs through portal

    Self-service registration, API key management, and testing are performed.
  </Card>
</CardGroup>

<Info>
  This integration between API Portal and API Manager bridges central API management and presentation to developers.
</Info>

## API Portal Advantages

<CardGroup cols={2}>
  <Card title="Self-Service" icon="user-gear">
    * Users manage their own accounts
    * They create API Keys themselves
    * Less management burden
  </Card>

  <Card title="Developer Experience" icon="code">
    * Easy API discovery
    * Detailed documentation
    * Testing tools
  </Card>

  <Card title="API Adoption" icon="arrow-trend-up">
    * Increases API usage
    * Facilitates developer onboarding
  </Card>

  <Card title="Integration" icon="plug">
    * Integration with existing systems
    * SSO support
  </Card>
</CardGroup>

## Next Steps

<CardGroup cols={2}>
  <Card title="API Portal Usage" icon="globe" href="/en/api-portal/overview">
    API Portal usage guide
  </Card>

  <Card title="API Portal Configuration" icon="gear" href="/en/api-portal/api-portal-settings">
    API Portal configuration
  </Card>

  <Card title="API Designer" icon="pencil" href="/en/concepts/core-components/api-designer">
    Learn about API Designer component
  </Card>

  <Card title="API Creator" icon="wand-magic-sparkles" href="/en/concepts/core-components/api-creator">
    Learn about API Creator component
  </Card>
</CardGroup>