Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

Creating a developer portal

This topic describes how to create your portal using Drupal portal development tools. For information about creating a portal using the simplified portal development tools provided with the New Edge experience, see Building your portal.

Log in to your portal

For Pantheon, the URL to your portal will be in the following form:

http://{environment}-{your-org-name}.devportal.apigee.io/

For portals created prior to June 15, 2017 that have not been migrated, the URL to your portal will be in the following form:

http://{environment}-{your-org-name}.devportal.apigee.com/

For example, for the dev version of the myorg portal: 

http://dev-myorg.devportal.apigee.io/

For a list of default portal URLs for Acquia, see Managing your environments.

When you log in with the administrator credentials you're given, you'll see something like this:

Notice:

  • 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. 

If you click the Apigee logo on your portal, you'll get to the home page.

Configure the connection between the portal and Edge

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.

There are three pieces of information that the portal needs 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 Private Cloud installation, the URL is in the form: http://EdgePrivateCloudIp:8080/v1​ or https://EdgePrivateCloudIp:TLSport/v1.

    Where EdgePrivateCloudIp is the IP address of the Edge Management Server server and TLSport is the TLS/SSL port for the 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 a developer administrator

    The calls from the portal to Edge are authenticated and require a user with Developer Administrator privileges. When a Developer Portal is provisioned for you, the Developer Administrator role is added to your organization. This role, which includes a single user called devadmin+{org_name}@apigee.com, is solely for the purpose of connecting your Developer Portal to your Edge organization. Because the portal displays your Edge developer apps, API products, and so on, it must stay in sync with your Edge organization by making management API calls that require authentication. The devadmin "user" has the necessary permissions.

    Don't add real users to the Developer Administrator role. (In fact, the management UI and API shouldn't let you.) That role should contain only the devadmin user.

To view the connection information:

  1. In the Drupal administration menu, select Configuration > Dev Portal > Application Settings.

To change the configuration:

How you change the configuration depends on your portal installation and portal version:

  • Cloud-based installation of portal version 15.01.06 and later: You must make a request to Apigee Support to change the connection information. For example, if you want to change the name of the organization.
  • On-premises installation and cloud-based portal previous to version 15.01.06: Change the connection information as described below:
  1. In the Drupal administration menu, select Configuration > Dev Portal Settings.
  2. Enter your organization name in Management API Organization.
  3. Enter the URL of the Edge endpoint in Management API Endpoint URL.
  4. Enter the organization administrator credentials in Endpoint Authenticated User and Authenticated User's Password.
  5. Select Test Connection to make sure the connection is successful.
  6. Select Save Configuration.

Create admin users

If you want to add more administrators to your portal:

  1. In the Drupal administration menu, select People > Add User.
  2. Enter the required information about the new user, and provide a temporary password.
  3. 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.

Configure an SMTP server

The developer portal requires that you configure an SMTP server to send email messages. To configure the SMTP server, you must first enable the Drupal SMTP Authentication Support module on the developer portal.

See Configuring email for more.

Configure your portal

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.

Create API products

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 Create API products.

Send developers to your portal

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?