AMPLIFYAPIManagement GettingStartedGuide AllOS en

AMPLIFY API
Management
30 July 2018
Getting Started Guide

Copyright © 2018 Axway. All rights reserved.
This documentation describes the following Axway software:
Axway AMPLIFY API Management
No part of this publication may be reproduced, transmitted, stored in a retrieval system, or translated into any human or
computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or
otherwise, without the prior written permission of the copyright owner, Axway.
This document, provided for informational purposes only, may be subject to significant modification. The descriptions and
information in this document may not necessarily accurately represent or reflect the current or planned functions of this
product. Axway may change this publication, the product described herein, or both. These changes will be incorporated in
new versions of this document. Axway does not warrant that this document is error free.
Axway recognizes the rights of the holders of all trademarks used in its publications.
The documentation may provide hyperlinks to third-party web sites or access to third-party content. Links and access to
these sites are provided for your convenience only. Axway does not control, endorse or guarantee content found in such
sites. Axway is not responsible for any content, associated links, resources or services associated with a third-party site.
Axway shall not be liable for any loss or damage of any sort associated with your use of third-party content.
Contents
Preface 6
Who should read this guide 6
How to use this guide 6
API Management documentation set 6
API Gateway documentation 6
API Manager and API Portal documentation 7
Accessibility 9
Screen reader support 9
Support for high contrast and accessible use of colors 9
Updates and revisions 10
1 AMPLIFY API Management overview 11

Key capabilities 11
API lifecycle 13
API management lifecycle 14
Key concepts 15
API provider 16
API consumers 16
API management 18
API development 19
API proxying 21
API versioning 21
Sandbox and production APIs 21
API consumer onboarding 23
Policy management and development 23
Main use cases 24
Digital transformation 24
API-centric application integration 25
Identity mediation and single sign-on 26
AMPLIFY API Management modules 27
API Builder 27
Mobile Backend Services 28
API Gateway 28
API Manager 29
API Central Service 29
API Portal 29
Embedded Analytics for API Management 29
Axway AMPLIFY API Management Getting Started Guide 3

Deployment options 30
Hosting options 30
Form factors 31
Reference architecture 32
Internal and external API Catalogs 33
Create and register APIs 33
Connect to the trial and marketplace 33
Try AMPLIFY API Management public cloud 33
Try AMPLIFY API Management private cloud or on premise 34
Accelerate your implementation 34
2 Installation 35
Install API Management modules 35
Install API Builder modules 35
Prerequisites 35
Install a deployment hosted in Axway Appcelerator cloud 36
Install a deployment hosted in a virtual private cloud (VPC) or an on-premise cloud 36
Secure the connection between API Manager and API Builder 36
Install Embedded Analytics for API Management modules 37
Deploy Mobile Backend Services 37
3 Discover API Management in Axway Cloud 38

Hybrid cloud solution 38
4 Create APIs 40
Create APIs using API Builder 40
Create APIs using API Gateway 40
5 Create policies 41
Integrate with back-end services 41
Configure security policies 41
6 Manage APIs 43
Register and virtualize REST APIs in API Manager 43
Register and manage application APIs in API Manager 43
Virtualize Mobile Backend Services in API Manager 44
Register native APIs 44
Access published APIs from API Manager 44
7 Provide a customized developer portal 45

Manage API consumers in API Manager 45
Customize API Portal 45

8 Monitor APIs 46
Trace and troubleshoot traffic 46
Get predictive insights 46
Monitor API usage 46
9 Add DevOps 47
Team development 47
Deployment and promotion 47
10 Multi-datacenter deployment 48

Preface
This guide provides an overview of the AMPLIFY API Management solution and describes its main
concepts, features, and architecture.
Who should read this guide

This guide is intended for AMPLIFY API Management architects and evaluators, and new users of
AMPLIFY API Management.
How to use this guide

This guide should be used with the other guides in the API Gateway, API Manager, AMPLIFY API
Central Service, API Builder, and API Portal documentation sets.
API Management documentation set

To find all available documents for this product version:
1. Go to https://docs.axway.com/bundle.
2. In the left pane Filters list, select your product or product version.
Note Customers with active support contracts need to log in to access restricted content.
API Gateway documentation

The API Gateway documentation set includes the following guides:
l API Gateway Installation Guide
Describes how to install API Gateway components on all platforms.
l API Gateway Upgrade Guide
Describes how to upgrade previous API Gateway versions.
l API Gateway Concepts Guide
Provides an overview of the API Gateway components, tools, and architecture.
l API Gateway Administrator Guide
Describes how to configure and manage an API Gateway domain.
l API Gateway Policy Developer Guide

Preface
Describes the main API Gateway features and how to configure them using the Policy Studio
graphical tool.
l API Gateway Policy Developer Filter Reference
Describes the filters that you can use when developing policies in Policy Studio, and how to
configure them.
l API Gateway DevOps Deployment Guide
Describes how to promote and deploy API Gateway configuration between different
environments (for example, development, testing, and production).
l API Gateway OAuth User Guide
Describes how to configure API Gateway for OAuth 2.0 and OpenID Connect.
l API Gateway Developer Guide
Describes how to extend, leverage, and customize API Gateway.
l API Gateway Key Property Store User Guide
Describes how to use the Key Property Store (KPS) to configure and manage data referenced
from policies running on API Gateway.
l API Gateway Kerberos Integration Guide
Describes how to integrate API Gateway with Kerberos SPNEGO authentication.
l API Gateway Authentication and Authorization Integration Guide
Describes how to integrate API Gateway with Identity Management systems (for example, LDAP
servers, CA Siteminder, and so on).
l API Gateway PassPort Interoperability Guide
Describes how to configure API Gateway and Axway PassPort to work together.
l API Gateway Sentinel Interoperability Guide
Describes how to configure API Gateway and Axway Sentinel to work together.
l API Gateway Validation Authority Interoperability Guide
Describes how to configure API Gateway and Axway Validation Authority to work together.
API Manager and API Portal documentation

The API Manager and API Portal documentation set includes the following guides:
l API Manager User Guide
Describes how to use the API management features available separately in API Manager. API
Manager is an additional licensable layered product running on API Gateway.
l API Portal Installation and Upgrade Guide
Describes how to install or upgrade API Portal. API Portal is an additional licensable layered
product running on API Gateway.
l API Portal Administrator Guide
Describes how to customize and manage API Portal.

Preface
l API Portal User Guide
Describes how to use API Portal.

Accessibility
Axway strives to create accessible products and documentation for users.
This documentation provides the following accessibility features:
l Screen reader support on page 9
l Support for high contrast and accessible use of colors on page 9
Screen reader support

l Alternative text is provided for images whenever necessary.
l The PDF documents are tagged to provide a logical reading order.
Support for high contrast and accessible use of

colors
l The documentation can be used in high-contrast mode.
l There is sufficient contrast between the text and the background color.
l The graphics have the right level of contrast and take into account the way color-blind people
perceive colors.

Updates and revisions
This guide includes the following documentation changes:
l Updated the guide with links to documentation for the latest g eneral availability (GA) releases
of API Gateway, API Manager, and API Portal.
l Updated the deployment options with the form factors available in the latest (GA) releases. For
details, see Deployment options on page 30.
l Added an overview of AMPLIFY API Central Service. For details, see AMPLIFY API Management
modules on page 27.
l Added an overview of Mobile Backend Services. For details, see AMPLIFY API Management
modules on page 27.
l Added information on how to virtualize APIs developed in API Builder in API Manager using API
Runtime Services connector. For details, see Register and manage application APIs in API
Manager on page 43.
l Added information on how to virtualize Mobile Backend Services in API Manager. For more
details, see Virtualize Mobile Backend Services in API Manager on page 44.
l Added a new topic on connecting to the AMPLIFY API Management trial and marketplace. For
more details, see Connect to the trial and marketplace on page 33.

AMPLIFY API Management
overview 1
AMPLIFY API Management is a bundle of API Builder, API Gateway, API Manager, API Portal, and
Embedded Analytics for API Management. You can also choose to use AMPLIFY API Central Service
instead of API Gateway and API Manager.
AMPLIFY API Management enables you to create APIs from cloud applications and on-premise
services, control the use of APIs, and enable self-service consumption of APIs.
This section introduces the AMPLIFY API Management solution, its business use cases, and provides
an overview of its main features.
l Key capabilities on page 11
l API lifecycle on page 13
l Key concepts on page 15
l Main use cases on page 24
l AMPLIFY API Management modules on page 27
l Deployment options on page 30
l Reference architecture on page 32
l Connect to the trial and marketplace on page 33
Key capabilities
The following diagram outlines the key components in AMPLIFY API Management solution, and how
they integrate with different services and channels.

1 AMPLIFY API Management overview
Create
AMPLIFY API Management provides multiple ways to create new APIs to ensure flexibility in
addressing a wide range of API provider scenarios:
l API Builder is the primary mechanism for creating new APIs that integrate with cloud or SaaS
and on-premise applications. Design, build, test, and run JavaScript-based APIs and micro-
services on a modern Node.js platform.
l API Gateway enables development of APIs that integrate with on-premise applications and
require data transformation or mediating API-centric identities to legacy identities.
l APIs that applications expose natively can be registered directly in API Manager.
Govern
All APIs are registered in API Manager to manage, secure and scale the API usage of the API
consumers.
l APIs are imported into API Manager and exposed with applied authentication, authorization and
quota management policies. You can also develop custom security and governance policies in
Policy Studio and apply them to your APIs.
l API Gateway provides security and threat protection capabilities deployed in the Demilitarized
Zone (DMZ) to secure external API traffic entering the enterprise.
l APIs can be accessed only through a secure SSL connection.
l APIs can be accessed only through API Manager to prevent client applications invoking the APIs
directly in an unsecured and unmanaged manner.

Consume
APIs are published to API Catalog in API Manager to enable API consumers to d iscover and use APIs
in their client and mobile applications. AMPLIFY API Management provides flexibility to support
multiple mechanisms for enabling API consumption:
l API Manager is the preferred option for internal-facing API Catalogs. It provides the developer
portal core capabilities for API consumers, such as self-registration, browsing the API Catalogs,
managing user credentials, and monitoring API usage.
l API Manager API enables you to create custom developer portals or integrate with your current
portals, leveraging your existing technologies and development skills.
l API Portal is an optional add-on to AMPLIFY API Management to provide a Joomla!-based
developer portal with blog and forum capabilities, branded and customized for external-facing
API Catalogs.
Measure
AMPLIFY API Management provides API usage analytics at all stages of the API lifecycle for both API
providers and API consumers.
l API Gateway provides real-time operational monitoring, enabling API providers to identify and
troubleshoot issues and to drill into individual API requests and message contents.
l API Manager and API Portal provide key API usage information on both API providers and API
consumers.
l API Gateway Analytics is an optional add-on to AMPLIFY API Management to provide you more
detailed historical API usage reports.
l Embedded Analytics for API Management provides preconfigured dashboards that provide real-
time operational and strategic analytics, enabling API providers to investigate both current and
past issues, as well as proactively identify abnormal situations before they become critical.
API lifecycle
AMPLIFY API Management provides complete coverage of the API lifecycle.

l CREATE – enable API providers to create new APIs from cloud, Software as a Service (SaaS), or
on-premise applications and data sources.
l GOVERN – manage, secure and scale the API usage of the API consumers.
l CONSUME – publish APIs to API Catalog to enable API consumers discover and use APIs as
self-service.
l MEASURE – monitor API usage analytics at all stages of the API lifecycle for both API providers
and API consumers.
API management lifecycle

API management lifecycle can be divided in six main phases, with different user roles and both
internal and external users participating in throughout the cycle:

1. API creation: External or internal API developers create and test APIs until they are ready to be

published.
2. API registration: API developers register the APIs, apply policies to the APIs, and test the APIs
in the sandbox API environment. The APIs are registered as unpublished.
3. API publishing: When the APIs have been successfully registered and tested, API developers
publish the APIs in the sandbox API environment. When the published APIs in API Catalog, API
administrators authorize API consumers to use the APIs to develop their client applications.
4. API promotion: After the APIs are published in the sandbox API environment, API

administrators can promote and publish APIs to the production API environment.
5. API deprecation: When API administrators deprecate APIs, they flag the APIs with a date
when they will be retired from API Catalog. API consumers can see the planned retirement date
in API Portal. The APIs are deprecated in both the sandbox API and production API
environments.
6. API retirement: When the APIs are retired, API administrators unpublish the APIs from API
Catalog. The retired APIs are no longer available to API consumers or client applications. The
APIs are retired in both the sandbox API and production API environments.
Key concepts
This topic introduces the key concepts and terminology in AMPLIFY API Management in detail.
l API provider on page 16
l API consumers on page 16
l API management on page 18
l API development on page 19
l API proxying on page 21
l API versioning on page 21

l Sandbox and production APIs on page 21
l API consumer onboarding on page 23
l Policy management and development on page 23
API provider
The API provider is the enterprise deploying Axway AMPLIFY API Management to expose APIs to API
consumers, like a credit card company providing payment services to various customers.
The API provider includes the following user roles:
l API administrator: An API administrator has the overall responsibility for managing the
consumption of APIs by API consumers. API administrator registers, tests, and publishes APIs to
API Catalog, manages API consumers and policies controlling their API use, and monitors
overall API usage.
l API developer: An API developer develops the back-end services and applications that expose
APIs. The API developer provides the details of the APIs to the API administrator who registers
and publishes them in API Catalog. If delegated API registration (optional) is configured, the
API developer can directly register, test, and publish the APIs.
l Policy developer: A policy developer uses Policy Studio to develop custom policies that can
be applied to APIs. The policy developer can double as an API developer and use Policy Studio
to develop new APIs from back-end services and applications that do not expose APIs.
l API Gateway administrator: An API Gateway administrator is a system administrator
responsible for monitoring the API Gateway and traffic flowing through it. API Gateway
administrator manages settings and configuration deployments, and troubleshoots any issues
in the API Gateway. For more details, see the API Gateway Administrator Guide.
API consumers
API consumers use the APIs that the API provider provides. API consumers can be organizations,
end users, client application developers, o r client applications. For example, the API consumers for a
credit card company could be specific hotel and retail organizations that enable their customers to
make payments by credit card.
The following diagram shows the API consumer organizations and user roles:

The API consumers can be grouped as follows:
l Organization: An organization defines the logical grouping of API consumers. An organization
can be either external, such as a business partner, or internal, like a business unit or project
team, to the API provider. Organizations are named and have a trusted relationship with the API
provider.
External and internal organizations can be included in the same deployment. With delegated
organization administration, the organizations can manage the application developers and
client applications in their own organization by themselves.
l Organization administrator: An organization administrator performs the administrative tasks
that the API provider chooses to delegate to the organization. The organization administrator
can use API Portal to manage client application developers within the organization, register new
developers, and manage the credentials and monitor the API usage of all client applications in
the organization.
l Community organization: A community organization provides an optional, built-in
organization of anonymous, untrusted API consumers not explicitly tied to any trusted
organization. The community organization provides a mechanism to recruit external client
application developers to browse APIs and to build client applications with minimal oversight
and approval.

API consumers in the community organization can be associated with a named organization
and become trusted. It is not recommended that production-level client applications run in the
community organization. Instead, these API consumers must move to a trusted organization
before the client application is deployed in production. Delegated organization administration
is not supported for the community organization, and there is no organization administrator.
l Client application developer: A client application developer develops and tests client
applications (mobile and web) that use the APIs the API provider provides. The client
application developer is a member of an organization and uses API Portal to browse API
documentation, try APIs, manage client application credentials, and monitor API usage.
l Client application: A client application consumes and invokes the APIs. The client
application can be a mobile application, a web application, or a system-level application. The
client application is associated with an organization.
API management
API management enables the API provider to publish REST APIs and SOAP web services to
consumers, and to manage how these consumers use the APIs.
The following diagram shows the high-level API management architecture:
This architecture includes the following capabilities:
l API Catalog and lifecycle management: API administrators and API developers can

register and manage the lifecycle of APIs. API Catalog lists published APIs that are available to
API consumers.
l API consumer management: API administrators can manage API consumers and apply
policies to manage how API consumers use the APIs. AMPLIFY API Management solution

includes partner-based management of API consumers. Delegated partner administration
enables partner organizations to manage their own API consumers, making it easier for you to
manage large partners or a large number of partners.
l Policy management and enforcement: Provides built-in authentication, authorization, and
quota management policies. These built-in policies can be extended with custom policies
specific to the API provider.
l Self-service API consumption: Application developers creating client applications that will
use the APIs can consume the APIs as self-service. Application developers can self-register,
browse API documentation, try APIs to understand their behavior, monitor their use of APIs,
and find support on the APIs from blogs and discussion forums in API Portal.
l Governance alerts: You can configure alerts generated for governance events associated with
APIs, API consumers, policies, or runtime events. These alerts trigger custom policies to take
the appropriate action, such as notifying an external notification system. The following are
examples when you could use a governance alert:
o When an API is deprecated and API consumers must be notified
o When a new client application developer is registered and needs API administrator
approval
o A client application reaches its API quota
API development
API proxying assumes that the back-end service exposes REST APIs or SOAP web services that can
be registered and proxied for API consumers to use. For more details, see API proxying on page 21.
With AMPLIFY API Management, you can develop REST APIs from non-REST API back-end services
using graphical p olicies.
The following diagram shows the API development architecture:

Note It is recommended that p olicy-based APIs are deployed on separate API Gateway that is

behind the internal firewall. In addition, the sandbox API and production API environments
have separate API Gateways running the sandbox and production policy-developed APIs.
You can define the REST API and the p olicy to integrate the REST API with the back-end services in
Policy Studio. You can then proxy the REST API and make it available to API consumers just like any
other API. If you want to expose a REST API proxy for a back-end service that does not offer a native
REST API, you must first develop a REST API for the back-end service. You can then proxy the newly
developed REST API.
For example, in the SOAP-to-REST use case, an existing SOAP web service must be exposed as a new
REST API. You design the REST API and integrate it with the SOAP web service. You proxy the REST
API and make it available to API consumers. In addition, you could orchestrate multiple calls to the
REST API to integrate it with multiple back-end services.
This way, there is a single consistent approach for registering APIs, proxying the APIs, and
managing how APIs are consumed in API Manager regardless of the back-end API implementation (a
native API or developed from a non-REST back-end API).
The lifecycle of policy-developed APIs is different to the lifecycle of the custom policies that are
deployed on the same API Gateway that is running API Manager.

API proxying
AMPLIFY API Management enables you to proxy REST APIs and SOAP web services and apply
policies to them to manage the consumption by API consumers. API consumers invoke the proxied
APIs, and after the policies are applied, the request is routed to the back-end REST API or SOAP web
service implementation.
API proxying includes the following approaches:
l Proxy API without modifications:The API provider proxies the API as is, without any

modifications. The proxied API exposed to API consumers is hosted on API Gateway, but it has
the same API definition (methods, parameters, and documentation) as the original API.
l Proxy API with modifications: The API provider proxies the API with modifications to make
the proxied API more consumer-friendly to the API consumers. These modifications could
involve any of the following:
o Remove methods
o Update the documentation
o Rename method paths and parameters
l Multiple proxied APIs: The API provider exposes the API as several different proxy APIs for
different API consumers. For example, different API methods could be exposed to different API
consumers, or different authentication policies could be used depending on the level of trust
with the API consumer.
The proxied APIs could have differences in the following:
o Methods exposed
o Documentation
o Method paths and parameters
o Authentication and policies
For details on API proxying a back-end service without a native REST API, see API development on
page 19.
API versioning
You can expose multiple versions of a single API to API consumers using AMPLIFY API Management.
Each version of the API is managed as an independent API, with its own unique URL and its own API
lifecycle.
For more details, see API provider on page 16.
Sandbox and production APIs

AMPLIFY API Management supports both sandbox and production APIs at runtime:

l Sandbox APIs: API consumers can use the sandbox APIs to see what APIs are available for the
API provider and to develop client applications against those APIs. Sandbox APIs route requests
to sandbox services that the API provider has made available to support the development of
client applications. Using API Portal, the application developer can browse the API
documentation, try APIs to understand their behavior, manage client application credentials,
and use the blogs and discussion forums to get more information. When the application
developer represents also the end user when developing the client application.
l Production APIs: Real end users using the client applications in production environment use
the production APIs. Production APIs route requests to the production services of the API
provider. Using API Portal, the application developer can manage client application credentials
and monitor how the client application uses the APIs.
AMPLIFY API Management deploys sandbox and production APIs into separate environments. The
different security and quality of service requirements between these environments keep sandbox
and production API traffic separate.
The following diagram shows example sandbox and production API environments:

API consumer onboarding

API consumers are first onboarded into the sandbox API environment where they can learn about
the available APIs and develop their client applications. Onboarding into the sandbox API means
that you can have more relaxed rules concerning registering API consumers (including self-
registration), and which APIs the consumers can access. The goal is to encourage consuming APIs,
and this approach makes it easier for a wide community of API consumers. When an API consumer is
ready to transition to production, the API consumer can be onboarded from the sandbox API
environment to the production API environment.
Onboarding API consumers into the production API environment means you must have more
governance processes in place. For example, to support the expected client application load for an
external business partner, you may need to have financial and legal criteria, quotas, and SLA
agreements all d efined and set up.
Policy management and development

In AMPLIFY API Management, you can apply policies to APIs to manage how API consumers use the
API.
The following diagram shows an overview of the policy management hierarchy:

AMPLIFY API Management provides a number of built-in policies that you can apply to APIs, for
example:
l Authentication mechanisms (such as, API keys or OAuth 2.0) for client applications
l Authorization mechanisms for controlling both organizations' and client applications' access to
APIs
l Quotas to limit the API requests that client applications can make
The API developer or API administrator can apply these custom policies when registering an API.
In addition to the build-in policies, you can also configure custom p olicies, and apply them to the
API request from the client application, the API response that is returned to the client application, or
the routing to the back-end service. For example, you may have specific security policies that need
to be applied to all API requests, or the identity of an end user of the client application may need to
be authenticated and mapped to a different token.
The custom policies are developed independently of APIs to build a library of policies that can be
applied to APIs. The policy developer uses Policy Studio to graphically develop. The developed
policies c an then be deployed in both the sandbox API and production API environments. The API
developer or API administrator can apply these custom policies when registering an API.
The lifecycle of these custom p olicies is different to the lifecycle of APIs.
Main use cases

Axway use cases are repeatable customer solutions that Axway invests in by enhancing its products.
For each use case, Axway identifies user personas, their goals and challenges, and documents how
its products support the use case.
Common use cases for AMPLIFY API Management include:
l Digital transformation on page 24
l API-centric application integration on page 25
l Identity mediation and single sign-on on page 26
l Extend the use of existing web services by converting them to REST APIs for use in mobile
applications.
l Expose and secure services on an Enterprise Service Bus (ESB) for external business partners.
l Create new APIs that aggregate capabilities of multiple cloud applications.
Digital transformation
AMPLIFY API Management enables digital transformation of organizations, end exposing easy-to-
consume APIs to digital consumers secured, managed, and integrated with the back-end application
services that cloud and on-premise applications provide.
This facilitates and accelerates how organizations design, secure, manage, and integrate APIs. It
also enables developers and partners to discover, subscribe, use, and monitor APIs.

This use case includes the following sub-use cases:
l API management for any application: APIs are consumed by a web application (B2C, B2E,

or B2B), web portal, mobile apps, connected things, or an API is promoted as a product.
l Real-time B2B integration using REST to SOAP: B2B interactions are performed using
REST APIs and SOAP APIs. APIs are exposed for partners to consume, and APIs exposed by
partners are consumed.
l Mobile application integration: APIs are consumed by B2C, B2E, or B2B mobile apps.
l Internet of Things (IOT) back-end service: APIs running on connected things are

consumed by internal applications, or enterprise APIs are consumed by connected things
directly.
API-centric application integration

This use case enables you to integrate two applications using real-time data replication mechanisms.
It uses a lightweight approach to application integration and real-time data replication patterns,
with a focus on integration using web API technology and an API Catalog.

This use case includes the following sub-use cases:
l Cloud-to-ground application integration: API-centric integration between cloud

applications (for example, Salesforce, ServiceNow, or Workday) and on-premise applications
(for example, ERP, SCM, or back-office).
l Ground-to-ground application integration: API-centric integration exclusively between
on-premise applications.
l Cloud-to-cloud application integration: API-centric integration exclusively between cloud
applications.
Identity mediation and single sign-on

This use case enables you to integrate with third-party identity management systems. The API
Gateway performs mediation between authentication and authorization systems on-the-fly, and can
act as a Policy Enforcement Point (PEP) for access control.

This use case includes the following sub uses cases:
l Single sign-on (SSO) scenarios
l Dynamic authentication and authorization
l Cloud Access Security Broker (CASB)
AMPLIFY API Management modules

AMPLIFY API Management is a bundle of the following products:
l API Builder on page 27
l Mobile Backend Services on page 28
l API Gateway on page 28
l API Manager on page 29
l API Central Service on page 29
l API Portal on page 29
l Embedded Analytics for API Management on page 29
API Builder
API Builder is a framework for building and running APIs either visually using the point-and-click
interface or programmatically.

API Builder has two main components, API Builder and API Runtime Services. With API Builder, you
can create APIs, models, and connectors to access data. Combine data from multiple sources,
optimize the payload size, convert data to mobile formats, and finally deliver data to any app client,
native or web. API Runtime Services provides a scalable infrastructure to run all your apps, as well as
a repository to store, find, and share reusable app and API components.
For more details on API Builder, see API Builder documentation.
Mobile Backend Services

Mobile Backend Services(MBS, formerly ArrowDB and Arrow Push) is an optional product that you
can include in AMPLIFY API Management. MBS provide pre-built and scalable cloud and mobile-
specific back-end services using REST APIs and data objects. These services can be, for example,
location-based services, social media integration, geo-location, photos, media handling, or sending
push notifications to mobile apps.
App developers can call the MBS APIs to integrate with their apps, and add mobile features without
the overhead of server coding or administration. Instead, developers can focus on client-side
development and thus reduce overall time to market for their apps. Software development kits
(SDKs) for integration with the following mobile platforms:
l Titanium
l Android
l iOS
l Node.js
For more details on Mobile Backend Services, see Mobile Backend Services documentation.
API Gateway
API Gateway is a server-side application you can use to manage, deliver, and secure APIs. API
Gateway provides services such as API integration, transformation, control and governance,
security, monitoring, development lifecycle, and administration.
With API Gateway you can bridge across different channels, from on-premises systems to cloud
services, and from mobile devices to the Internet of Things (IoT). Integrate with your existing
applications, identity management systems, communication protocols and other assets out of the
box.
API Gateway comes with Policy Studio, an Eclipse-based graphical integrated development
environment (IDE). Using Policy Studio, you can quickly to define, configure and manage API
policies and open up existing applications as APIs. The web-based dashboards of API Gateway
Manager and API Gateway Analytics provide managing and monitoring API deployments at runtime.
Gain real-time end-to-end visibility on the API usage, and receive alerts and troubleshoot APIs to
find and fix issues. This helps you minimize business disruption and gain insights how to improve
business performance.
For more details, see API Gateway Concepts Guide.

API Manager
API Manager is a web-based API administration and management tool layered on API Gateway.
With API Manager, you can build a central catalog of all available APIs, and virtualize them as
needed. This way, you can centrally govern your APIs and how and by whom they are consumed.
Secure APIs using a broad range of security and authentication profiles, and protect the back end
with throttling and quota management policies. In addition, you can connect in one click with the
most popular cloud applications and expose their APIs, or create complex integration scenario using
custom advanced integration policies.
For more details, see API Manager User Guide.
API Central Service

AMPLIFY API Central Service is a next-generation API governance solution. It is a cloud-based
system for self-service API management across multiple environments and clouds. API Central
Service enables you to virtualize, secure, deploy, and manage your APIs, client applications, and
users.
API Central Service provides:
l Unified support for APIs with a consistent user experience.
l Central, cloud-based governance with hybrid runtime deployment.
l Self-service governance to support massive organizational adoption.
For more details, see API Central Service User Guide.
API Portal
API Portal is a self-service developer portal layered on both API Manager and API Gateway.
API Portal enables both internal or external client application developers to browse, consume, build,
and test APIs for use in their applications on their own. You can use several channels, such as FAQs,
articles, forums or blogs, to provide more information for the developers and to encourage
developer engagement. The look and feel of the web-based API portal is fully customizable to match
your brand and image.
For more details, see API Portal Administrator Guide.
Embedded Analytics for API Management

Embedded Analytics for API Management provides preconfigured Decision Insight dashboards that
provide real-time operational and strategic analytics for API Management.
With preconfigured Decision Insight dashboards, you can investigate both current and past issues,
as well as proactively identify abnormal situations before they become critical.

You can set up multiple dashboards geared for different roles in API Management or addressing
different domains. This provides different viewpoints to the same API activity depending on role in
question. You can also customize dashboards to enhance and fine-tune the analytics metrics to suit
your needs and environment.
For more details, see Embedded Analytics for AMPLIFY API Management documentation.
Deployment options
The following explains the different options for hosting you AMPLIFY API Management solution as
well as the form factor available for each module.
l Hosting options on page 30
l Form factors on page 31
Hosting options
You can choose how you want your AMPLIFY API Management deployment to be hosted:
l On-premise hosting on page 30
l Virtual private cloud hosting on page 31
l Axway Cloud hosting on page 31
On-premise hosting
Hosting your AMPLIFY API Management deployment on-premise offers you the following form factor
options: a software installation o r Docker containers. You can also mix different form factors across
the solution.

On-premise hosting means the solution can be located fully within your domain, increasing security.
You are fully in control of the whole AMPLIFY API Management solution, which on one hand means
increased flexibility and customization options, but on the other hand also added overhead and
increased resource requirements.
If your API consumers are only internal, such as employees or business partners who have access to
your internal network, hosting AMPLIFY API Management on-premise is the best option because
there is no benefit to a cloud solution in this case.
Virtual private cloud hosting

You can use any Platform as a Service (PaaS) vendor to host your VPC. Axway offers Docker
resources for all AMPLIFY API Management modules that you can deploy and run in containers in
your VPC.
VPC hosting makes the hardware infrastructure and its maintenance a service you can outsource,
making scaling the system to your needs quicker and easier . Even without managing the hardware
yourself, you still manage the AMPLIFY API Management solution like in on-premise hosting.
VPC is excellent for external API consumers who do not have access to your internal network. As a
cloud solution, it is also accessible from anywhere.
Axway Cloud hosting

Axway Cloud is fully managed by Axway. All that is left for you to start is to select the region where
you want to host your AMPLIFY API Management.
Axway Cloud is the turnkey solution when time to market is of the essence. The solution is ready to
use for you without any management overhead. While this does mean less flexibility for
configuration options, it also means simplicity and quickly getting on with the basic use cases.
Like VPC, Axway Cloud is excellent for external API consumers as well as accessible from anywhere.
Form factors
AMPLIFY API Management modules are available as follows:
Module Form factors
API Builder l Software installation on Windows, UNIX/Linux,
and macOS
l Docker
Mobile Backend Services l Axway-hosted API Runtime Services VPC
l Axway Appcelerator Public Cloud

Module Form factors
API Gateway and API Manager l Software installation on UNIX/Linux
l Docker
AMPLIFY API Central Service AMPLIFY Platform
API Portal l Software installation on Red Hat Enterprise Linux 7
l Docker
Embedded Analytics for API l Software installation on Windows and UNIX/Linux
Management l Docker
The available options depend on the component and how your AMPLIFY API Management is hosted.
Reference architecture
The following diagram shows the recommended AMPLIFY API Management reference architecture.
API Builder is deployed in the internal network behind the internal firewall on a dedicated set of
machines.
A single API Management d omain is deployed. The domain consists of two groups:
l Internal-facing API Management group for internal API consumers. This is deployed in the
internal network behind the internal firewall.
l 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.
Connect to the trial and marketplace

This topic explains how to try AMPLIFY API Management and how to access assets on GitHub.
Try AMPLIFY API Management public cloud

To try API Management in a public cloud, register an account on platform.axway.com and use API
Builder and API Central Service.

Try AMPLIFY API Management private cloud or

on premise
To try API Management in a private cloud or on premise, sign up for a free trial at
www.axway.com/en/api-management-trial and use API Manager and API Portal.
You can follow the steps in the API Management Tutorial to learn the basic capabilities.
Accelerate your implementation

To leverage assets that accelerate your implementation, connect to the Axway marketplace o r
directly to the Axway AMPLIFY API Management GitHub repository.

Installation
2
This section provides the outline how to install AMPLIFY API Management solution.
l Install API Management modules on page 35
l Install API Builder modules on page 35
l Install Embedded Analytics for API Management modules on page 37
l Deploy Mobile Backend Services on page 37
Install API Management modules

Because some of the API Management modules depend on other modules, you must install the
modules in the following order:
1. Install API Gateway.
2. Install API Manager.
3. Install API Portal.
You can install API Gateway and API Manager together in one installation dialog.
Tip API Gateway installer comes with a Quickstart demo that walks you through the key
components and example operations.
API Portal has its own installer. After installing API Portal, you must link it to API Manager.
For more details on installing and configuring the modules API Gateway and API Manager for either
a single-node or a multi-node high-availability (HA) deployment, see the API Gateway Installation
Guide.
For more details on installing API Portal, see the API Portal Installation and Upgrade Guide.
Install API Builder modules

The modules you need for API Builder depend on how your deployment is hosted.
Prerequisites
Before you start installing API Builder components, you must add the IP address of the machine
running API Builder to the DNS or to hosts file on any other machine accessing AMPLIFY API
Management. For example:

2 Installation
10.142.59.203 appc02.axway.int
In addition, after you have installed API Builder, you must add the domain API Builder is running in
to the list of allowed domains in API Builder.
Install a deployment hosted in Axway

Appcelerator cloud
If your deployment is hosted in Appcelerator cloud, do the following:
1. Install Node.js.
2. Install API Builder CLI.
3. Configure API Runtime Services.
For more details on installing and configuring API Builder, see API Builder Getting Started Guide.
Install a deployment hosted in a virtual private

cloud (VPC) or an on-premise cloud
If your deployment is hosted in a virtual private cloud (VPC) or an on-premise cloud, install the
following:
1. Install Node.js.
2. Install Appcelerator Private VMWare OVA file for Arrow Cloud installation on a private cloud
using its OS-specific installer file.
For more details on installing and configuring API Runtime Services Self-install documentation.
Secure the connection between API Manager

and API Builder
It is recommended that you secure the connection from API Manager to API Builder, so that only API
Manager can invoke API Builder APIs. This p revents a client application by-passing API Manager and
invoking an API Builder API directly, resulting in the client application accessing the API Builder API
without the security and governance controls API Manager enforces.
For more details, see "Configure a connector for Axway API Runtime Services" in the API Manager
User Guide

2 Installation
Install Embedded Analytics for API

Management modules
For Embedded Analytics for API Management, do the following:
1. Install Decision Insight.
2. Download the Embedded Analytics for API Management package and import it into Decision
Insight.
For more details on installing and configuring Decision Insight, see the Decision Insight
documentation.
For more details on configuring Embedded Analytics for API Management, see Embedded Analytics
for AMPLIFY API Management documentation.
Deploy Mobile Backend Services

For Axway Mobile Backend Services (MBS), do the following:
1. Deploy MBS to a Docker container. For more details, see API Runtime Services Self-install
documentation.
2. Create a datasource for MBS. For more details, see Mobile Backend Services Getting Started .

Discover API Management in
Axway Cloud 3
Axway offers Axway Cloud as the deployment option AMPLIFY API Management. Axway Cloud is the
turnkey solution when time to market is of the essence. Both the cloud infrastructure and AMPLIFY
API Management are fully managed by Axway, so the solution is ready to use for you without any
management overhead.
Hybrid cloud solution

In addition to the all-cloud deployment for the AMPLIFY API Management, you can also select a
hybrid deployment combining on-premise and cloud.
The following diagram shows an example of the hybrid model:
One or more development environments are deployed on-premise, while the test or staging
environment and production environment are hosted in a virtual private cloud (VPC) in Axway
Cloud. You get a predefined and secured VPC architecture while leveraging your existing
infrastructure in the development environment.
The development environment has unlimited term license for AMPLIFY API Management. You can
combine the design tools, such as Policy Studio and Configuration Studio, and the AMPLIFY API
Management runtime components that Axway provides with your own DevOps tools and continuous
integration and continuous deployment (CI/CD) chains. Axway provides a secure deployment
channel from on-premise development environment to the test or staging environment in the Axway
Cloud and further on to the production environment.

3 Discover API Management in Axway Cloud
The staging and production environments in Axway Cloud are fully managed by Axway and use
Axway CI/CD chains. You can access the web UIs of the products in both environments simply using
a standard browser. The production environment can be configured for high availability (HA).
Axway also provides additional services, such as building, deploying, and maintaining
customizations you need to the system. These customer artifacts may include the following:
l Policies
l API Builder APIs
l API Catalog
l Client registry
l API Portal customizations
l API Gateway Analytics reports
l Embedded Analytics for API Management dashboards
For more details on products in Axway Cloud, see the following:
l API Manager User Guide
l API Portal Cloud User Guide
l API Gateway Analytics User Guide

Create APIs
4
AMPLIFY API Management provides two ways to create new APIs.
Create APIs using API Builder

API Builder is the primary option for creating new APIs.
In API Builder, APIs are created as projects, standard Node.js applications running in the Arrow
Cloud environment. You create a project, add API end-points ( API Builder APIs) to define ways how
client applications can access your API, or other components, such as models. Once your API is
ready, API Builder generates a Swagger 2.0 definition for the API (see API Builder Console
documentation). You can then import the Swagger definition to API Manager and register the API.
API Builder comes with prebuilt connectors for different services, such as Salesforce, Azure, MS SQL,
MySQL, MongoDB, orSwagger, making integration with cloud applications and services easy. In
addition you can create custom connectors for any data source, and reuse the connectors as needed
in your APIs. For easy integration with mobile applications, you can optimize the payload size and
data format for your APIs.
For a walk-through of the basics of API creation, see API Builder Getting Started Guide.
Create APIs using API Gateway

Sometimes it may be better to create new APIs using API Gateway, especially when integrating with
back-end services. For example, you might need to bridge an API Key or OAuth identity of the API in
API Manager to an identity used by back-end services, like Kerberos. Or the back-end service you are
integrating with might require JSON/XML data transformation for request/response messages.
You can create new APIs in Policy Studio using the REST API development wizard. The REST APIs
can be based on existing back-end REST or non-REST APIs, but you must specify a custom routing
policy for REST API methods. The policies for request and response processing are optional, and
you can specify them as required. When your API is ready, you can register it in API Manager.
For more details on creating new APIs in Policy Studio, see "Develop REST APIs in Policy Studio" in
the API Gateway Policy Developer Guide.

Create policies
5
A policy is a network of message filters, and each filter is a modular unit that processes a message. A
message can traverse different paths through the policy, depending on which filters succeed or fail.
A policy can also contain other policies, so you can build modular, reusable policies.
AMPLIFY API Management provides a number of built-in policies that you can apply to APIs. In
addition, policy developers can use Policy Studio, a graphical tool, to develop custom policies.
In Policy Studio, a policy is assembled by selecting filters from the filter palette on the right and
dragging and dropping them onto the policy canvas to be configured. The configured filters are
then connected to a policy using success and failure paths to trace a path through a set of filters and
create sophisticated rules. Some filters require configuring additional resources or settings before
the filters can be used. You can find these additional resources and settings from the node tree on
the left.
For more details on Policy Studio, see the API Gateway Policy Developer Guide.
Integrate with back-end services

In AMPLIFY API Management, API Gateway provides integration across systems and compatibility.
REST-SOAP conversion enables you to make enterprise application data and operations available to
mobile apps. You can convert a legacy SOAP service, and deploy it as a REST API. API Gateway then
can expose the REST API that maps to the SOAP service, dynamically creating a SOAP request based
on the REST API call.
For more details, see the API Gateway Concepts Guide and the API Gateway Policy Developer Guide.
Configure security policies

You can use policies to enhance security. The support for a wide range of security standards enables
identity mediation between different identity schemes.
Data is routed based on sender identity, content, and type. This means that messages are sent to the
appropriate application in a secure manner. It also enables service virtualization, where services are
exposed to clients with virtual addresses to mask their actual addresses and shield endpoint services
from direct access for added security.
Data monitoring, redaction, encryption, and signing facilitates privacy compliance support. For
example, you can encrypt sensitive information, such as customer names, or strip that information
out of message traffic.

5 Create policies
For identity management, you can configure different kinds of authentication policies in Policy
Studio, and integrate with existing third-party Identity Management (IM) infrastructures for
authentication and authorization.
For more details, see the following:
l API Gateway Concepts Guide
l API Gateway Policy Developer Guide
l API Gateway Authentication and Authorization Integration Guide
l API Gateway Kerberos Integration Guide

Manage APIs
6
In AMPLIFY API Management, API Manager provides a web-based interface to easily manage your
APIs.
Register and virtualize REST APIs in API

Manager
You can register APIs in a browser, in multiple formats, and without any service outage, as well as
apply policies the APIs and to virtualize them on API Gateway.
API Manager has two key concepts, back-end API and front-end API. A back-end API is the
definition of the API that you register into API Manager. A front-end API is the virtualized publicly
exposed proxy of the back-end API that routes to the back-end API. The front-end API is hosted on
API Gateway and invoked by client applications.
By default, the front-end API is the same as the back-end API, proxying the API as is. However, you
can edit the front-end API, like change the URL path, change and map parameters, or improve the
documentation, to present an enriched, public-facing API to client applications. In addition, the
back-end API can change over time and you can control how changes are exposed to client
applications, thus minimizing or eliminating the potential impact on these applications.
For more information on registering and virtualizing APIs in API Manager, see the API Manager User
Guide.
Register and manage application APIs in API

Manager
You can create APIs as cloud-based Node.js applications in API Builder that run in, for example API
Runtime Services virtual private cloud (VPC). API Builder generates a Swagger definition for the
application API, and you c an use the API Builder connector to import the Swagger definition to API
Manager. For more details, see "Configure a connector for Axway API Runtime Services" in the API
Manager User Guide.

6 Manage APIs
Virtualize Mobile Backend Services in API

Manager
You can virtualize the Swagger definitions of the Mobile Backend Services (MBS) in API Manager and
add them to your API Catalog. This enables you to include additional features, such as quota
control, threat protection, or user authentication and authorization policies, and to expose MBS in
your API Portal to your developer community for easy discovery and on-boarding. For more details,
see "Connect to Axway Mobile Backend Services" in the API Manager User Guide.
Register native APIs

If you need to expose native APIs exposed by cloud applications or back-end services “as is”, you
can register these APIs d irectly in API Manager and publish them in API Catalog. You can then use
API Manager to secure the APIs and manage how API consumers can access them. For more details
on registering APIs in API Manager, see "Manually register a new back-end REST API" in the API
Manager User Guide
Access published APIs from API Manager

When you publish an API, it gets a URI of the following format:
GUID.<domain_name from the config>
For example:
73b332f7c1af1f57e962822d2abfca5ddb61296a.appc02.lab.dubl.axway.int
To access the API Builder browser interface for the API, go to https://<GUID.<domain_
name from the config>/arrow. For example:
https://73b332f7c1af1f57e962822d2abfca5ddb61296a.appc.axway.int/arrow
To access the Swagger definition for the API, go to https://GUID.<domain_name from
the config>/arrow/swagger.json. For example:
https://73b332f7c1af1f57e962822d2abfca5ddb61296a.appc.axway.int/arrow/sw
agger.json

Provide a customized
developer portal 7
You can use API Portal to add a dedicated developer portal to offer your APIs and their associated
documentation to both internal and external developer communities. API Portal provides a
customizable interface to API Manager, while managing the APIs exposed and the API consumers is
retained in API Manager.
Manage API consumers in API Manager

Developers can self-register on the API Portal login page. The API administrator manages the users
in API Manager, and can approve or reject new users as they register.
Developers can use API Catalog to browse, consume, build, and test APIs for use in their
applications. They can register their applications, as well as obtain credentials, such as API Key or
OAuth, for the applications. The API administrator approves or rejects the registered applications. If
an approved application needs access to another API, the API administrator manages these requests
as well. If needed, the user and application management can be automatically approved or
delegated to organization administrators.
For more details, see "Administer APIs in API Manager" in the API Manager User Guide.
Customize API Portal

The look and feel of the web-based API Portal is fully customizable to match your brand and image.
The easiest way to customize API Portal is the Joomla! Admin Interface (JAI). You can modify logos,
colors, fonts, and CSS stylesheets. For more extensive modifications, you can also change the page
layout or portal structure. The customizations are retained when you upgrade to a new version.
For more details on customizing API Portal, see the API Portal Administrator Guide.

Monitor APIs
8
AMPLIFY API Management provides several ways to monitor your APIs and environment.
Trace and troubleshoot traffic

Use API Gateway Manager web console to monitor your API Gateway. The different tabs provide
real-time information on the distributed topology with a real-time overview of message traffic by
domain, group, and API Gateway instance.
The Traffic Monitor enables real-time monitoring of message traffic, enabling easy identification of
exceptions, and drilling into policy execution steps and message content to perform root cause
analysis.
For more details on API Gateway Manager, see the API Gateway Administrator Guide.
Get predictive insights

Embedded Analytics for API Management provides pre-configured ADI dashboards that provide real-
time operational and strategic analytics for AMPLIFY API Management. With Embedded Analytics for
API Management, you can investigate both current and past issues, as well as proactively identify
abnormal situations before they become critical.
For more details, see Embedded Analytics for AMPLIFY API Management documentation.
Monitor API usage

API administrators and organization administrators can use the Monitoring tab in API Manager to
view metrics on all invoked APIs and client applications in the system. Administrators can also
optionally use API Gateway Analytics to provide more detailed historical API usage reports. In
addition, API consumers can use the Monitoring page in API Portal to view graphical real-time charts
on how their applications use APIs exposed in API Portal.
The monitoring data in API Manager, API Gateway Analytics, and API Portal is obtained from the
metrics database. You can filter the metrics displayed b ased on several different criteria.
For more details, see "Monitor APIs and applications in API Manager" in the API Manager User Guide.
For details of how to set up the metrics database, see "Configure the metrics database" in the API
Gateway Installation Guide.

Add DevOps
9
DevOps (from "software development" and "information technology op erations") refers to a set of
practices emphasizing the collaboration and communication of both software developers and IT
professionals while automating the delivery process and infrastructure changes. DevOps aims at
building, testing, and releasing software rapidly, frequently, and reliably.
Team development
In AMPLIFY API Management, API Gateway team development makes it possible for a team of p olicy
developers to work in parallel using a project-based approach to develope APIs, policies, and
associated resources, and to deploy them as a single API Gateway configuration using a Source
Code Management (SCM) system.
Team development incorporates continuous integration (CI) and continuous delivery (CD) practices
in API Gateway system to use the best practices for development, deployment, and promotion, and
to support the increasing use of DevOps tooling.
For more details, see "Introduction to API Gateway team development" in the API Gateway DevOps
Deployment Guide
Deployment and promotion

In a typical AMPLIFY API Management environment topology, the development, staging and
production environments are completely separate domains and distinct administrative entities that
may even be running on different operating systems. The exact mapping of environments to
domains is determined by how each environment is administered, and which users have access
rights.
The configured or developed artifacts (such as APIs, policies, and configurations) move from
development to production. Deployment refers to deploying a configuration to the local domain.
Promotion refers to p hysically moving a configuration from one environment to another, and
configuring environment-specific values so that the configuration can be deployed in each
environment.
For more details, see "Introduction to API Gateway d eployment and promotion" in the API Gateway
DevOps Deployment Guide

Multi-datacenter
deployment 10
You can configure your AMPLIFY API Management to globally span multiple datacenters. By
providing a datacenter geographically close to your operations and your customers, you can
significantly impact the latency of the traffic.
In addition, using multiple datacenters helps to ensure constant operation. If one datacenter fails
and goes down, traffic can be routed to another, working datacenter.

10 Multi-datacenter deployment
A single API Gateway group configuration is shared across the datacenters. This means that all API
Gateway instances are managed as a single unit, and run the same configuration to virtualize the
same APIs and execute the same policies. Data is replicated between all datacenters.
Each datacenter must have at least two API Gateway instances, at least one of which is an Admin
Node Manager. However, you can configure mutliple Admin Node Managers per datacenter for high
availability.
For more details on multi-datacenter deployment, see "Configure API Management in multiple
datacenters" in the API Gateway Installation Guide.

AMPLIFYAPIManagement GettingStartedGuide AllOS en

Hochgeladen von

Dokumentinformationen

Originaltitel

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

AMPLIFYAPIManagement GettingStartedGuide AllOS en

Hochgeladen von

Copyright:

Verfügbare Formate

Getting Started Guide

Updates and revisions 10

1 AMPLIFY API Management overview 11

Axway AMPLIFY API Management Getting Started Guide 3

3 Discover API Management in Axway Cloud 38

7 Provide a customized developer portal 45

Axway AMPLIFY API Management Getting Started Guide 4

Axway AMPLIFY API Management Getting Started Guide 5

Who should read this guide

How to use this guide

API Management documentation set

API Gateway documentation

Axway AMPLIFY API Management Getting Started Guide 6

API Manager and API Portal documentation

Axway AMPLIFY API Management Getting Started Guide 7

Axway AMPLIFY API Management Getting Started Guide 8

Screen reader support

Support for high contrast and accessible use of

Axway AMPLIFY API Management Getting Started Guide 9

Axway AMPLIFY API Management Getting Started Guide 10

Axway AMPLIFY API Management Getting Started Guide 11

Axway AMPLIFY API Management Getting Started Guide 12

Axway AMPLIFY API Management Getting Started Guide 13

API management lifecycle

Axway AMPLIFY API Management Getting Started Guide 14

1. API creation: External or internal API developers create and test APIs until they are ready to be

4. API promotion: After the APIs are published in the sandbox API environment, API

Axway AMPLIFY API Management Getting Started Guide 15

Axway AMPLIFY API Management Getting Started Guide 16

Axway AMPLIFY API Management Getting Started Guide 17

l API Catalog and lifecycle management: API administrators and API developers can

Axway AMPLIFY API Management Getting Started Guide 18

Axway AMPLIFY API Management Getting Started Guide 19

Note It is recommended that p olicy-based APIs are deployed on separate API Gateway that is

Axway AMPLIFY API Management Getting Started Guide 20

l Proxy API without modifications:The API provider proxies the API as is, without any

Sandbox and production APIs

Axway AMPLIFY API Management Getting Started Guide 21

Axway AMPLIFY API Management Getting Started Guide 22

API consumer onboarding

Policy management and development

Axway AMPLIFY API Management Getting Started Guide 23

Main use cases

Axway AMPLIFY API Management Getting Started Guide 24

l API management for any application: APIs are consumed by a web application (B2C, B2E,

l Internet of Things (IOT) back-end service: APIs running on connected things are

API-centric application integration

Axway AMPLIFY API Management Getting Started Guide 25

l Cloud-to-ground application integration: API-centric integration between cloud

Identity mediation and single sign-on

Axway AMPLIFY API Management Getting Started Guide 26

AMPLIFY API Management modules

Axway AMPLIFY API Management Getting Started Guide 27

Mobile Backend Services

Axway AMPLIFY API Management Getting Started Guide 28

API Central Service

Embedded Analytics for API Management

Axway AMPLIFY API Management Getting Started Guide 29

Axway AMPLIFY API Management Getting Started Guide 30

Virtual private cloud hosting

Axway Cloud hosting

Module Form factors

Axway AMPLIFY API Management Getting Started Guide 31