API Portal overview

AxwayAPI Portal is a self-service developer portal layered on both API Manager and API Gateway.

With API Portal, you can enable 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.

API Portal is part of the Axway AMPLIFY API Management solution. For more details, see the AMPLIFY API Management Getting Started Guide.

Diagram illustrating the API Management concepts in API Portal

Key capabilities in API Portal

API Portal is built on top of Joomla!, an open source CMS platform for developing and deploying websites.

API Portal provides the following capabilities specifically for the API administrator:

  • User and application administration — You can execute basic operations, such as approvals and rejections, on both API Portal users and their applications.
  • Customization to provide a branded experience — You can customize the look and feel of API Portal to match your own brand, and provide a branded developer portal.

API Portal provides the following capabilities for both internal and external application developers:

  • Self-registration and profile management — Application developers can self-register and manage their profiles.
  • Browsing and testing APIs in API CatalogAPI Catalog contains the APIs that have been registered in API Manager and are available for use. Application developers can browse these APIs and their associated documentation, and invoke APIs using the built-in test capability. They can also download API definitions (Swagger or WSDL) and client SDKs (iOS, Android, Titanium, or Node.js).
  • Creating and managing applications — Application developers can register their applications that use the APIs, and obtain API Key or OAuth or external credentials for their applications.
  • Monitoring API usage — Application developers can register their application's use of APIs through graphical real-time charts.
  • Pricing - You can provide specific pricing information relating to APIs, products, plans, and services.
  • Help Center — Provides a central point for links that you can use to offer additional information, for example, FAQs, documentation, discussion forums, or further contact information.
  • Blog and Discussion forums - These are Joomla! plugins from a third-party vendor that you can use to share information and interact with the developer community.
  • Documentation - You can use content management capabilities of Joomla! to provide additional content relating to your APIs, terms and conditions for their use, or best practices to your developer communities. The content can include PDF documents, images, and videos.

Additional features – API Catalog view

API Portal offers two rendering options to customize the visualization of the APIs and their methods.

Swagger.io SwaggerUI

This option shows the commonly known fields of a method, and it is the default option for SOAP APIs.

AMPLIFY SwaggerUI

In addition to the commonly known fields of a method, the AMPLIFY option also provides the following:

  • Body Parameters - Shows the body of the parameter and its JSON schema.
  • Examples (or, snippets) - This section displays a line or block of code that you can copy and paste, and run straight away using the relevant tool (curl, Titanium, node.js, web.js).
  • OAuth Authorization code flow - Allows you to request a token to authorize access to your requests using an OAuth authorization code, as opposed to the Client credentials option where you need a secret key to request the token.

The AMPLIFY option also allows you to customize the method colors (grayscale or colorful). It is the default option for REST APIs.

API Portal users

This section describes the type of users and their roles in API Portal.

  • API administrators – Full control over API Manager APIs, as well as of API Manager features (Users, Organizations, Monitoring applications, etc). They can, for example, assign an API Portal user to an organization administrator role in API Manager.
    For more details, see the API Manager User Guide.
  • Organization administrators – Full control over their organization in API Manager and the users and applications belonging to it. They have also an additional menu item, Users, in the API Portal menu.
  • Application developersAPI Portal users who write and test applications, and consume the exposed APIs.
  • Joomla! administrators - Full control over API Portal configuration (look and feel, and localization).
Note   API administrators and Joomla! administrators are different users, for different applications, and their roles do not overlap.

Related Links