You're viewing Apigee Edge documentation.
Go to the Apigee X documentation.

As an API provider, you have developed a set of APIs to provide access to your backend services. Your next step is to build your developer portal to enable app developers to:

  • Learn about your data and service offerings
  • Learn how to use your APIs by reviewing comprehensive documentation, including example use case, tutorials, and reference documentation
  • Register using a self-service process in order to build apps that use your APIs

Overview of developer portal solutions

Apigee supports several developer portal solutions, summarized in the following table, ranging from simple turn-key to fully customizable and extensible. When choosing a solution, you need to balance your customization requirements against the time and knowledge required to implement your portal.

Solution Features Hosted by Apigee? Support
(Requires licensed subscription)
Apigee integrated portal Simple self-service portal development.
(Apigee Edge Public Cloud customers only)
Yes Apigee 24/7 support
Drupal 10 portal Fully customizable self-service portal development using open source Drupal 10 projects. Integration with Apigee using the Apigee Edge module. No Apigee 24/7 support for break-fix issues
Custom portal Fully customizable do-it-yourself portal development using Apigee platform APIs. No Apigee 24/7 support for Apigee platform APIs only

Choose your developer portal solution

To help you decide which developer portal solution to choose, consider the following decision tree and review the Comparison of developer portal features.

Flow diagram showing when to use Drupal and when to use Apigee integrated portal

If you are an Apigee Edge for Public Cloud customer, consider building an Apigee integrated portal if you plan to support common use cases for portal development, such as standard registration and app creation flows, and more stylistic than functional changes.

Drupal-based portals are the only option at this time for Apigee Edge for Private Cloud and monetization customers.

Comparison of developer portal features

The following table provides a comparison of features between the Apigee integrated portal and the Drupal-based developer portal.

Feature Integrated portal Drupal
Portal content development using Markdown green check icon green check icon
Portal content development using HTML green check icon green check icon
API reference doc rendered from OpenAPI specifications green check icon green check icon
OpenAPI Specification version 3 support green check icon green check icon
Send live requests from your API reference green check icon green check icon
Custom theme green check icon green check icon
Custom menus green check icon green check icon
Third-party tags, like Google Analytics green check icon green check icon
Custom JavaScript code green check icon green check icon
Custom domain name green check icon green check icon
HTTPs enabled green check icon green check icon
Terms and conditions for account creation green check icon green check icon
Mobile device display optimization green check icon green check icon
Integration with custom scripts and script tags green check icon green check icon
SMTP configuration green check icon green check icon
Email template configuration green check icon green check icon
CAPTCHA to prevent spam green check icon green check icon
Roles and permissions for developer/consumer accounts green check icon green check icon
Federated login green check icon green check icon
Content management APIs Using Drupal
Monetization Coming soon green check icon
Search configuration * green check icon
Blog and forums ** green check icon
Page templates for content creation green check icon
App analytics on the portal green check icon
Rules-based event management green check icon
Extensible with add-on modules green check icon
Custom app registration flows green check icon
Custom developer registration flows green check icon
Portal logs green check icon
Link checker green check icon
Microsoft Internet Explorer/Microsoft Edge support Microsoft Edge only green check icon
Apigee support See table above See table above

Build an integrated portal

If you're an Apigee Edge for Public Cloud customer, you can create a lightweight developer portal quickly in the Edge UI. Navigate to, sign-in, and select Publish > Portals in the side navigation bar of the Edge UI. For complete details, see Build your integrated portal.

The following figure shows the landing page for the integrated portal.

Portal intro

Build a Drupal-based portal

Using the Drupal portal development tools, you can build a fully customizable developer portal. Drupal provides a rich set of functionality and all the CMS capabilities of Drupal with additional Apigee-developed Drupal modules. However, implementing a Drupal-based portal requires more time and effort.

Apigee Edge is compatible with the following Drupal versions:

Version Description
Drupal 10 Provides a reliable customer-managed, open-source, enterprise-level content management system (CMS). Because Drupal 10 is open-source, you can extend and contribute to the Drupal 10 portal development framework and leverage the knowledge of the Drupal community. For more information, see Build your portal using Drupal 10.

Build a custom portal using Apigee Edge APIs

Build your own, fully customized portal leveraging Apigee Edge APIs summarized in the following table. For more information, see:

Category Apigee APIs Description
Analytics Stats View analytics for your APIs.
API Keys App Keys: Developer

App Keys: Company

Manage API keys used to authorize the usage of APIs in apps.
API Products API Products Manage the API products that you publish to the developer portal.
Applications Apps

Apps: Developer

Apps: Company

Manage the applications registered by developers to consume your APIs.
Developers Developers


Company Developers

Manage the developers that have registered on your developer portal.
Monetization Monetization Monetize your APIs.

Simplify the integration of your portal client using the Apigee Edge Client Library for PHP. The SDK makes it easy to write PHP modules that use the Apigee APIs described in the previous table. For more information about the Apigee API Client Library for PHP, see: