{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"overview-of-the-apigee-integration-portal","__idx":0},"children":["Overview of the Apigee integration portal"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://cloud.google.com/apigee/docs/api-platform/get-started/what-apigee"},"children":["Apigee"]}," is a platform for developing and managing APIs, and API proxies."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using the Redocly portal starter repository, you can integrate your Developer portal with the Apigee via a special authorization proxy."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Redocly provides the proxy source code that you can host in your own Apigee account."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using the Redocly portal, organization owners can:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Write contextual documentation in Markdown (or MDX)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Integrate interactive API samples right into the contextual descriptions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Generate high-quality API reference pages with a try it console and code samples."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Style and theme it to match your brand guidelines."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Control the navbar, footer and sidebar navigation."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["With this Apigee integration, portal users can leverage Redocly's portal features and integrate with your Apigee APIs to build a great developer onboarding experience."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create a new app to generate an API key."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Manage API keys."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Manage apps."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Try it"]}," console to test the APIs."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To see the developer experience, read our sample developer documentation to ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs-legacy/developer-portal/guides/apigee-integration-portal/manage-apps-keys"},"children":["manage apps and API keys using the developer portal"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-does-the-redocly-portal-work-with-an-apigee-api","__idx":1},"children":["How does the Redocly Portal work with an Apigee API?"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n subgraph Apigee\n pr[Apigee authorization proxy]\n api[Apigee API]\n pr -- set up for --> api\n end\n subgraph dp[Portal]\n app1[App 1]\n pr1[Product 1]\n pr2[Product 2]\n pr3[Product 3]\n app1 -- pairs with --> pr1\n app1 -- pairs with --> pr3\n app2[App 2]\n app2 -- pairs with --> pr2\n app2 -- pairs with --> pr3\n end\n dp[Developer portal] -- integrates with --> Apigee\n","diagramHtml":"

integrates with

Portal

pairs with

pairs with

pairs with

pairs with

App 1

Product 1

Product 3

App 2

Product 2

Apigee

set up for

Apigee authorization proxy

Apigee API

","diagramHtmlDark":"

integrates with

Portal

pairs with

pairs with

pairs with

pairs with

App 1

Product 1

Product 3

App 2

Product 2

Apigee

set up for

Apigee authorization proxy

Apigee API

"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"why-set-up-a-proxy","__idx":2},"children":["Why set up a proxy?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The proxy is required because Apigee's API is not designed to be consumed directly from the browser by a developer."," ","The proxy adds logic to verify the developer's identity, and restrict usage of Apigee's backend API as appropriate to a developer."," ","This diagram shows the architecture."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/apigee-proxy-architecture-12c599e4e7a41411.png","alt":"Apigee proxy architecture"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also add capabilities such as security-related logging and monitoring and case-specific logic using the API proxy."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information, refer to Apigee's documentation on ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://docs.apigee.com/api-platform/fundamentals/understanding-apis-and-api-proxies"},"children":["Understanding APIs and API proxies"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"steps-to-set-up-the-apigee-integration","__idx":3},"children":["Steps to set up the Apigee integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before users can start creating apps and managing API keys using the Developer portal, you must:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs-legacy/developer-portal/connect-developer-portal"},"children":["Add a Developer portal"]},"."," ","To configure the Developer portal, see our ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs-legacy/developer-portal/configuration"},"children":["Configuration"]}," guide."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": You can use an existing Developer portal for the Apigee integration."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs-legacy/settings/identity-providers"},"children":["Connect your identity provider"]}," on Redocly Workflows (if your organization hasn't already done so)."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs-legacy/developer-portal/guides/apigee-integration-portal/setup-apigee-proxy"},"children":["Set up and configure the Apigee proxy"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs-legacy/developer-portal/guides/apigee-integration-portal/enable-ui-components"},"children":["Enable the developer UI components"]}," in your portal, to show ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Apps"]}," under the profile."]}]}]}]},"frontmatter":{"seo":{"title":"Overview of the Apigee integration portal"},"excludeFromSearch":true},"tagList":["admonition"],"title":"Overview of the Apigee integration portal","lastModified":"2025-05-28T16:01:32.000Z"}