Apigee

The Apigee module enables you to connect a Drupal 9+ site to Apigee Edge or Apigee X in order to build a developer portal:

• Users that register or are added to the Drupal site will be added as developers in Apigee.
• Click on “My Apps” in user menu to get keys for the APIs exposed in Apigee.

This module includes the following submodules:

• API product RBAC: enables administrators to configure access permissions to API products.
• Debug: enables administrators to configure and manage Apigee debug logs.
• Teams: enables developers to be organized into teams.

For more details read the Apigee module documentation.

Note: If you are brand new to Drupal or Drupal-based developer portals, we strongly recommend using the Apigee Developer Portal Kickstart Drupal distribution to get up and running quickly. The Kickstart bundles together all of the open source Apigee Drupal modules and libraries that you need to create a portal, configure a connection to Apigee X or Edge, showcase your API products, and publish your API reference documentation. For more information, see the Apigee Developer Portal Kickstart project page and documentation.

Module status

Following the same concept of Drupal 8 Experimental modules, some submodules are marked as “Experimental”. They are provided for evaluation and testing purposes but are still considered to be in development. Experimental modules are included in the “Apigee (Experimental)” package on the “Extend” page of a Drupal site (/admin/modules).

Installing

Note: The Apigee module requires Drupal 8.7.x or higher and PHP 7.1 or higher.

1. Install the Apigee module using Composer.
   
   Composer will download the Apigee module and all its dependencies.
   
   Note: Composer must be executed at the root of your Drupal installation.
   
   For example:

   cd /path/to/drupal/root
   composer require drupal/apigee_edge
   

   For more information about installing contributed modules using composer, see the official documentation.

2. Click Extend in the Drupal administration menu.
3. Select the Apigee module.
4. Click Install.

Notes

• If you use the default configuration for Apigee connection settings, you must configure the private filesystem correctly or the connection will not work. Make sure the private filesystem is outside your web server's document root so that you can ensure the key is not compromised.
• If you do not configure the connection between Drupal and Apigee, you will not be able to register developers on the site and may cause other issues with Drupal core functions. If you do not plan to configure the connection between Drupal and Apigee, you should uninstall the Apigee module.
• When you first install the module, existing users in the Drupal site may not have a developer account in Apigee. You can run developer synchronization to make sure Drupal users and Apigee developers are synchronized.

Requirements

• Drupal 8’s minimum requirement is phpdocumentor/reflection-docblock:2.0.4 but at least 3.0 is required by this module. If you get the error “Your requirements could not be resolved to an installable set of packages” it may be because you are running reflection-docblock version 2. You can update phpdocumentor/reflection-docblock with the following command: composer update phpdocumentor/reflection-docblock --with-dependencies.
• Check composer.json for required patches. Patches prefixed with “(For testing)” are only required for running tests. Those are not necessary for using this module. Patches can be applied with the cweagans/composer-patches plugin automatically or manually.
• (For developers) The locked commit from behat/mink library is required otherwise tests may fail. This caused by a Drupal core bug. See the related pull request for behat/mink here.

Troubleshooting

• File entity module. If you installed the File entity module then you are going to need the latest patch from this issue otherwise you can run into some problems.

Development

Development is coordinated in our GitHub repository. The drupal.org issue queue is disabled; we use the GitHub issue queue to coordinate development.

Support

This project, which integrates Drupal 8 with Apigee, is supported by Google.