viewing Apigee X documentation.
View Apigee Edge documentation.
Apigee delivers a simple-to-use, integrated portal to document and manage access to your APIs, and foster your app developer community.
All users of Apigee have access to the integrated portal development tools enabling them to build their own developer portal quickly, providing an alternative to the Drupal-based portal development. For a feature comparison, see Comparison of developer portal features.
Video: Watch this short video for an introduction to building and publishing your integrated portal.
Key features and benefitsThe integrated portal provides you with the following key features and benefits:
|Portal content development||Develop your portal content quickly and easily.
|Portal look-and-feel||Fully customize the look-and-feel of your portal using SCSS style sheets and personalized branding.|
|API documentation||Auto-generate API reference documentation based on your OpenAPI Specifications.|
|Self-service registration||Provide self-service registration for developers to build apps using your APIs.|
|Audience management||Control who can access the portal content and APIs|
|Analytics||Configure Google Analytics and custom analytics tracking.|
|Advanced customizations||Perform advanced portal customizations, including:
How Apigee addresses security in the integrated portal
The following table describes how Apigee addresses security through built-in features in the integrated portal.
|Requires HTTPS and transport layer security (TLS)||Enforces encrypted communication|
||Disallows "supercookies" from being set on subdomains of
||Guards against HTML, SQL, or backend injection attacks|
||Disallows browsers from trying to guess MIME types|
||Disallows embedding portal content into an iFrame|
||Disallows pages from loading when they detect reflected cross-site scripting (XSS) attacks|
|Uses CSRF tokens||Guards against cross-site request forgery|
|Leverages:||Customer data protections|
How the integrated portal communicates with Apigee
A majority of the information used by the developer portal is stored on Apigee. The portal acts as a client to Apigee. As necessary, the developer portal sends an HTTP or HTTPS REST request to retrieve information from or send information to Apigee. For example, when a portal user registers a new app on the portal, the portal sends a request to Apigee to store information about the app.
The following sections provide more detail.
Where app registration and API keys are stored
When a portal user completes the app registration process on the integrated portal, the portal sends information about the app to Apigee, including the app name and the API products associated with the app. If Apigee registers the app successfully, Apigee returns a single API key to the portal. The portal user uses that API key to access the API products associated with the app.
Information about the apps and API keys is stored on Apigee only; it is not stored on the portal. When a portal user uses the portal to view information about an app, via the My Apps page for example, the portal makes a request to Apigee with the API key to access the information.
Similarly, when a portal user adds, removes, or modifies an app, the portal sends the modifications to Apigee to be stored.
Because all information about apps and API keys is stored on Apigee, an Apigee administrator can modify the information by using the Apigee UI or management API. For example, an administrator can:
- Add, remove, or modify a developer app
- Approve or revoke an API key for a developer app
For more information, see Controlling access to your APIs by registering apps.
Where app developer account information is stored
Developer account information is stored on Apigee, as follows:
- Using the built-in identity provider, when a portal user creates an account, the information is stored in the identity provider and is displayed on the Users page.
- Using the SAML identity provider, when a portal user signs in to the portal, a shadow record of the information is stored in the identity provider and is displayed on the Users page.
- After a portal user registers a developer app, the user account information is synced to and available on Apigee on the Developers page.
The following user account information is stored on Apigee:
- First and last name
- Email address
- Portal account status (active or inactive)
- Portal role (authenticated user, administrator, other)
- Role-based permissions
- Teams to which the portal user is a member (if you have enrolled in the beta release of the teams feature)
The email address is the primary key used by Apigee to identify the developer and each must be unique. From the primary key, Apigee generates a unique developer ID for each organization to which the developer belongs.
For more information, see Register app developers.
Where developer team information is stored (beta)
When a developer team is created on the portal by a portal user, the developer team information is stored on Apigee, including:
- Developer team name and description
- Developer team members and their roles
- Apps to which the developer team is assigned
- Audiences assigned to the developer team
- Time the developer team was created
A unique, auto-generated email address is generated for the developer team and serves as the primary key used by Apigee to identify the developer team.
For more information, see Share responsibility for an app using developer teams (beta) and Manage developer teams.
About the sample portal
When you create a new portal, a set of starter pages is provided for you to use as a jump-off point. The starter pages contain demo content to help inspire your own portal development as you replace the text and images with your unique content. The sample portal theme uses material design theming and SCSS.
The following shows the home page of the sample portal.
The starter pages provided with the sample portal include:
|Home||Portal home page that describes the APIs that are showcased. Serves as default home page for your portal (index.html). Demonstrates use of angular material components, as described in Add angular material components.|
|Get Started||Sample content page. Learn how to edit this page and add it to the top navigation by stepping through the tutorial.|
|APIs||List of available APIs. When you generate interactive API reference documentation, links to the content are added to this page automatically.
Note: The contents of this page are auto-generated based on the APIs that you publish to your portal. You cannot edit the contents of this page directly; it does not appear in the pages list. You can modify the styling of the page using the portal theme editor.
|My Apps||List of registered apps for an authorized user. See How portal users interact with your portal.
Note: The contents of this page are auto-generated based on the registered user apps. You cannot edit the contents of the page directly; it does not appear in the pages list. You can modify the styling of the page using the theme editor.
|Sign in||Sign in page for registered users. New users can register from this page by clicking Sign In. See How portal users interact with your portal.
Note: The Sign In page is included in your portal automatically. You can customize the logo on the Sign In page and add custom registration fields to the Create Account page. You cannot edit the contents of the page directly; it does not appear in the pages list. "
|Terms and Conditions||Sample terms and conditions page.|