What is API Developer Portal?
API Developer Portal (API Geliştirici Portalı) is a comprehensive self-service platform used to offer your APIs published on Apinizer API Gateway to developers, partners, and end users. This portal enables you to grow your API ecosystem by making your APIs discoverable, documented, and easily usable.Core Functions
API Developer Portal performs the following core functions:- API Catalog: Presenting your APIs in a categorized, searchable catalog
- Self-Service Registration: Allowing developers to create their own accounts and subscribe to APIs
- API Documentation: Facilitating API usage with automatic and manual documentation
- API Key Management: Credential management for secure API access
- Pricing and Plans: Different usage plans and monetization strategies
- Analytics and Monitoring: API usage statistics and performance metrics
- Test Tools: Ability to test APIs through the portal
- Visibility Control: Access management based on Public, Private, and Authorized Organizations
Usage Scenarios
- Public API Portal: Offering APIs open to general use
- Partner API Portal: Offering APIs exclusive to specific partner companies
- Internal API Portal: Offering APIs to internal developers
- API Monetization: Generating revenue from API usage
- Developer Onboarding: Quickly integrating new developers
- Growing API Ecosystem: Attracting more developers and applications
Portal Types
Apinizer API Portal offers flexible visibility and access control for different usage scenarios.Public API Portal (Public Portal)
When to Use:- When you want to offer APIs open to general use
- When you want to reach as many developers as possible
- When following an open API strategy
- When focused on marketing and dissemination
- Anyone can register on the portal
- All published APIs are visible to everyone
- Self-service registration and approval process
- Access to a wide user base
- Weather APIs
- Map services
- General data APIs
- Open data platforms
Partner API Portal (Partner Portal)
When to Use:- When you want to offer APIs exclusive to specific partner companies
- When you want to share APIs for B2B integrations
- For APIs requiring controlled access
- When you want to offer exclusive solutions to enterprise customers
- Only authorized organizations can access
- Organization-based visibility control
- Partner-based custom plans and pricing
- Advanced security and access control
- Payment gateway integrations
- Enterprise data sharing
- B2B service integrations
- Exclusive partner solutions
Internal API Portal (Internal Portal)
When to Use:- When you want to offer APIs to internal developers
- For integration between internal systems
- When you want to manage internal API ecosystem
- For centralized API management and documentation
- Only internal users can access
- Access over internal network
- Company authentication system integration
- Internal usage-focused plans
- Microservice APIs
- Internal system integrations
- Inter-departmental API sharing
- Enterprise API catalog
Apinizer API Portal Features
Apinizer API Portal offers the following comprehensive features:API Product Management
Package, categorize, and publish your APIs as products. Define different visibility levels and plans.
Self-Service Registration
Allow developers to create their own accounts. Automatic or manual approval processes.
API Documentation
Automatic OpenAPI/Swagger documentation and custom documentation pages. Code examples and usage guides.
API Key Management
Secure credential creation, rotation, and management. Application-based API keys.
Pricing Plans
Free, Subscription, Metered, and Tiered plans. Flexible pricing for API monetization.
Test Tools
Test APIs through the portal. Try It console, JSONPath, XPath, and transformation tools.
Analytics and Monitoring
API usage statistics, traffic analysis, and performance metrics. Dashboards and reports.
Organization Management
Organization-based access control and visibility management. Organization administrators.
Support Packages
SLA levels, support channels, and package management. Support requests and Jira integration.
Customizable Theme
Customize portal appearance with logos, colors, fonts, and HTML content.
Multi-Language Support
Turkish and English language support. Multi-language content management.
Email Notifications
Automatic email templates. Registration, approval, rejection, and notification emails.
Portal Modules
API Developer Portal consists of the following modules:API Product Management
The API Product module turns your APIs into products that can be created and published to offer them to end users through the portal. Features:- Packaging API Proxies or Proxy Groups as products
- Category-based organization
- Visibility control (Public, Private, Authorized Organizations)
- Pricing plans (Free, Subscription, Metered, Tiered)
- Documentation and file management
- Automatic OpenAPI/Swagger integration
Accounts and Developers
The Accounts/Developers module provides management of portal users and developers. Features:- Self-service registration and approval process
- Profile management
- Organization administrator permissions
- API Access Token creation and management
- Password management and security
Application Management
The Application Management module manages applications created by portal users to access APIs. Features:- Portal App creation and management
- API Key (Credential) creation and rotation
- API Product subscriptions
- Application-based usage tracking
Portal Settings
The API Portal module manages the portal’s basic configurations. Features:- General settings (name, URL, language)
- Email notifications and templates
- Security settings (registration, approval, credential management)
- Features (Test Tools, Analytics, Jira integration)
- Legal regulations and SEO
Appearance and Theme
The Appearance and Theme module allows you to customize the portal’s visual identity. Features:- Logo and favicon management
- Color palette and theme settings
- Home page content
- Footer and “How It Works” page
- Multi-language content management
Test Tools
The Tools module offers various test and transformation tools to portal users. Features:- JSONPath testing
- XPath testing
- XML/JSON transformation
- Base64 encode/decode
- JWT decode
- JSON Schema generation
Support Packages
The Support Packages module manages support services to be offered to users. Features:- Support package creation and management
- SLA levels and features
- Pricing
- Support request management
- Jira integration
Organization Visibility
The Organization Visibility module enables you to track organizations’ API usage. Features:- Organization-based API access reports
- Account and API product relationships
- Status tracking and analysis
Portal Workflow
Developer Perspective
- Registration: Registers on the portal and confirms email
- Approval: Account is approved (automatic or manual)
- Discovery: Reviews API catalog and finds APIs of interest
- Application Creation: Creates an application to access APIs
- Subscription: Subscribes to desired API Product by selecting a plan
- Getting API Key: Receives API Keys after subscription is approved
- Test and Usage: Tests with Try It console and uses in application
- Monitoring: Monitors usage with Analytics
Administrator Perspective
- Portal Setup: Configures portal settings
- API Product Creation: Packages and publishes APIs as products
- Visibility Settings: Selects Public, Private, or Authorized Organizations
- Plan Definition: Creates pricing plans
- Approval Management: Approves developer registrations and subscriptions
- Monitoring: Reviews usage statistics and reports
- Support: Manages support requests
Portal and Manager Relationship
API Developer Portal works closely integrated with Apinizer API Manager:- API Manager: Where API Proxies are created, configured, and deployed
- API Portal: Where APIs published in API Manager are offered to developers
- One-Way Data Flow: Portal reads API information from Manager; changes made in Manager are automatically reflected in Portal
- Publishing: When API Products are published in Manager, they become visible on Portal
Important Notes
- For Portal to work, API Proxies must be created and deployed in API Manager
- If Elasticsearch integration is done from portal settings, analytics features can be used
- Self-service registration feature must be enabled from portal settings
- Both language options must be active for multi-language support