Creating a developer portal
To get your portal created, go to this page and request a developer portal. Be sure to give them your enterprise.apigee.com organization name. If you don't know your organization name, sign in to http://enterprise.apigee.com and select your username > User Settings. In the User Settings window, you can see your organization name.
After you request the portal, an Apigee representative will respond with more information. Ultimately, you'll be sent a note with links to:
- Your portal , a ready-to-use Drupal instance with the following pages: homepage, Blog, Forum
(Apigee Edge customers on paid accounts receive multiple sites with duplicate portal environments: Dev, Test, and Live.)
- A dedicated Github repository containing the code and files for your portal. For example, the code for your portal's themes resides in this repository.
The URL to your portal will be in the form of:
For example, for the dev version of the myorg portal:
When you log in with the administrator credentials you're given, you'll see something like this:
- Menu items for the pre-built Blog and Forum pages.
- A Drupal administration menu only available to Drupal administrators of your portal. This is where portal administrators perform much of the site's configuration. Any modifications that require coding, such as modifying or creating themes, is done with PHP code stored in Github.
If you click the Apigee logo on your portal, you'll get to the home page.
The portal acts as a client for Apigee Edge. That means the portal does not function as a stand-alone system. Instead, much of the information used by the portal is actually stored on Edge. When necessary, the portal makes an HTTP or HTTPS request to retrieve information from Edge or to send information to Edge.
As part of creating your portal, you must configure the connection to Edge. There are three pieces of information that you need for your portal to communicate with Edge:
- URL of the Edge endpoint
The default endpoint for the cloud-based version of Edge is https://api.enterprise.apigee.com/v1.
For an Edge OPDK installation, the URL is in the form: http://EdgeOpdkIp:8080/v1 or https://EdgeOpdkIp:SSLport/v1.
Where EdgeOpdkIp is the IP address of the Edge Management Server server and SSLport is the SSL port for the OPDK Edge management API. For example, 8443.
- Apigee organization name
This is the name of your organization on Edge. You set up the organization when you create your account on Edge.
- Username and password of an organization administrator
The calls from the portal to Edge are authenticated and must be performed by an administrator for your organization.
This username/password is for an administrator on your organization and should be used only for connecting to Edge from the portal. For example, if you specify the credentials of a user, and that user is ever deleted on Edge, then the portal will no longer be able to connect to Edge. Therefore, create an administrator on your organization just for this connection.
To configure the connection:
- In the Drupal administration menu, select Configuration > Dev Portal Settings.
- Enter your organization name in Management API Organization.
- Enter the URL of the Edge endpoint in Management API Endpoint URL.
- Enter the organization administrator credentials in Endpoint Authenticated User and Authenticated User's Password.
- Select Test Connection to make sure the connection is successful.
- Select Save Configuration.
If you want to add more administrators to your portal:
- In the Drupal administration menu, select People > Add User.
- Enter the required information about the new user, and provide a temporary password.
- Be sure to select Active and administrator. To have an automatic email sent to the user with a link to the new portal, select Notify user of new account.
When a new administrator logs in, he or she will have the same administrator rights as you.
Drupal runs almost entirely on modules—self-contained code plug-ins to the Drupal framework. Anything you do or configure in Drupal is controlled by a module, from menu control, to layout configuration, to reports. To see a list of modules that are installed in your portal, select Modules in the Drupal menu.
To start configuring your portal, see Add and edit content.
Before you send developers to your portal, be sure you have API products (bundles of APIs) to select when they create apps on your portal. For more information, see Creating API products.
When your portal is ready for public consumption, start sending developers to it. When they register, they're added as simply "authenticated users" (not Drupal administrators), and their user information is automatically added to Drupal—and to your enterprise.apigee.com environment, where they are registered as "developers". When developers register apps in your developer portal, where they select API products to use in their apps, those apps are also registered on your enterprise.apigee.com site. Your developer portal and enterprise site are connected.
Help or comments?
- Something's not working: See Apigee Support.
- Something's wrong with the docs: Click Send Feedback in the lower right.
(Incorrect? Unclear? Broken link? Typo?)