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 7 portal||Fully customizable self-service portal development using Drupal 7. Integration with Apigee using the Apigee Edge module.||No||Apigee 24/7 support for Apigee platform APIs only|
|Drupal 8 portal||Fully customizable self-service portal development using open source Drupal 8 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.
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
|Portal content development using Markdown|
|Portal content development using HTML|
|API reference doc rendered from OpenAPI specifications|
|OpenAPI Specification version 3 support|
|Send live requests from your API reference|
|Third-party tags, like Google Analytics|
|Custom domain name|
|Terms and conditions for account creation|
|Mobile device display optimization|
|Integration with custom scripts and script tags|
|Email template configuration|
|CAPTCHA to prevent spam|
|Roles and permissions for developer/consumer accounts|
|Blog and forums||**|
|Page templates for content creation|
|App analytics on the portal|
|Rules-based event management|
|Extensible with add-on modules|
|Custom app registration flows|
|Custom developer registration flows|
|Microsoft Internet Explorer/Microsoft Edge support||Microsoft Edge only|
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 https://apigee.com/edge, 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.
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 supports the following Drupal versions:
|Drupal 8||Provides a reliable open-source, enterprise-level content management system (CMS). Because Drupal 8 is open-source, you can extend and contribute to the Drupal 8 portal development framework and leverage the knowledge of the Drupal community. For more information, see Build your portal using Drupal 8.|
|Drupal 7||Provides a reliable, enterprise-level content management system (CMS), but that is not open source. Available by request for paid accounts only. For more information, see Build your portal using Drupal 7. Contact Apigee Support for assistance if you wish to use Drupal 7 for your portal development.|
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:
|Analytics||Stats||View analytics for your APIs.|
|API Keys||Developer App Keys||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||Manage the applications registered by developers to consume your APIs.|
|Developers||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: