Introduction

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

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. Yes Apigee 24/7 support
Drupal-based portal Fully customizable self-service portal development using Drupal 8 (open source) or Drupal 7. Integration with Apigee using the Apigee Edge module. No
  • Community-based or Drupal Enterprise Support Add-on
  • Apigee 24/7 support for Apigee platform APIs only
Custom portal Fully customizable do-it-yourself portal development using Apigee platform APIs. No Apigee 24/7 support for Apigee platform APIs only

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

Portal intro

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
Portal content development using HTML
API reference documentation generated from OpenAPI (Swagger) specifications
Send live requests from your API reference
Page templates for content creation
Custom theme
Custom menus
Third-party tags, like Google Analytics
Custom JavaScript code
Custom domain name
HTTPs enabled
Terms and conditions for account creation
Mobile device display optimization
Search configuration *
Blog and forums **
BugHerd integration ***
SMTP configuration
Email template configuration
CAPTCHA to prevent spam Coming soon
App analytics on the portal
Monetization Coming soon (Drupal 7)
Coming soon - Drupal 8
Roles and permissions for developer/consumer accounts Coming soon
Federated login Coming soon
Rules-based event management
Extensible with add-on modules
Custom app registration flows
Custom developer registration flows
Portal logs
Link checker
Microsoft Internet Explorer/Microsoft Edge support Microsoft Edge only

Prerequisites

You must have an Apigee Edge account, as described in Create an Apigee Edge account.

For the number and types of developer portal environments available to you, see Apigee Edge Pricing & Features.

Build an integrated portal in the New Edge experience UI

If you're a Cloud customer, you can create a lightweight developer portal right away in the New Edge experience UI. Navigate to https://apigee.com/edge, sign-in, and select Publish > Portals in the side navigation bar of the New Edge experience UI. For complete details, see Build your 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:

Version Description
Drupal 8 (Beta) 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 (Beta).
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 management APIs

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

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

Company 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

Developer Apps

Company Apps

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

Companies

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: