Reference architecture

The following diagram shows the recommended AMPLIFY API Management reference architecture.

Picture of API Management Plus reference architecture

API Builder is deployed in the internal network behind the internal firewall on a dedicated set of machines.

A single API Management domain is deployed. The domain consists of two groups:

  • Internal-facing API Management group for internal API consumers. This is deployed in the internal network behind the internal firewall.
  • External-facing API Management group for external API consumers. This is deployed in the DMZ.

Both API Management groups have two API Gateway instances deployed on separate machines for HA.

For more details on API Management domains and groups, see API Gateway Concepts Guide.

Internal and external API Catalogs

Each API Management group has its own API Catalog, enabling internal-facing and external-facing APIs to be partitioned into dedicated API Catalogs.

APIs intended for internal API consumers are registered with API Manager in the internal-facing group and published to that API Catalog. Likewise, APIs for external API consumers are registered with API Manager in the external-facing group and published to that API Catalog. If an API is made available to both internal and external API consumers, it is registered and published to both groups.

Internal client application developers can use the internal API Catalog to browse and consume the internal-facing APIs available to them. They belong to the internal group in API Manager or API Portal.

External client application developers can use the external API Catalog to browse and consume the external-facing APIs available to them. They belong to the external group in API Manager or API Portal.

Create and register APIs

For cloud applications and back-end services that expose APIs natively, you can register the APIs directly in API Manager. You can either import the API definition (Swagger, RAML, or WADL), or manually register the API. The API consumers are accessing the API “as is” but with API Manager securing and managing access.

You can use API Builder to create new APIs that integrate with cloud applications and back-end services. API Builder generates a Swagger 2.0 definition for the API. This definition is then imported into API Manager to register and publish API to API Catalog.

If you use API Gateway to develop a new API, the API is deployed to a API Gateway instance in the internal-facing API Management group. You can use API Manager to register the API to the internal-facing or external-facing API Management group, or both.

Related Links