api portal
February 28, 2020

What Is an API Portal?

Developer Portal
API management

So you’ve created an API – now what? It doesn’t do any good if it isn’t shared with the community, whether internal or external. That’s where an API portal comes into play.

What Is an API Portal?

An API portal bridges the gap between API providers and API consumers. In other words, it connects the product to the community. Community can mean many things – internal, external, or partners – and primarily consists of developers. Which is why an API portal is often referred to as a developer portal.

API Portal Benefits

At Akana, we refer to our API portal as Community Manager. Community Manager is a sophisticated API portal that acts as an interface between an API and its stakeholders. This is a single portal interface that can be branded and customized within our API management platform.

The portal allows API providers to publish, document, promote, and support their APIs. App developers can use the portal to find, consume, and get support for the APIs their apps use. Essentially, it provides a hub to engage a partner ecosystem and build new revenue channels for your business.

Features and benefits of the Akana API Portal include:

Engaging Developers and Partners

With an API portal, you can create a social channel to manage and promote your APIs within the community. A portal also facilitates consumer and partner onboarding. This helps them find the right API and manage approvals.

Capabilities of the Akana API portal include:

  • Support: API developers can request help for an API or app by opening a ticket, and then follow updates on ticket status.
  • Collaboration: API developers can contribute, discuss and provide feedback, enriching the community and your API.
  • Stay Informed: API developers can follow an API and/or app and see an activity stream of all activity related to that item.

API Documentation and Testing

Providing documentation on an API’s functionality is an integral component in the onboarding process. This documentation contains the API's technical content, including instructions on how to effectively use and integrate APIs. In addition, documentation contains info on version control, retirement, and ongoing API updates.

With the Akana Community Manager, dynamically generated documents allow administrators to more easily upload and manage API documentation.

Capabilities of the Akana API portal include:

  • Supporting multiple countries through multi-language support.
  • Controlling visibility of documents and document elements via licensing.
  • Providing a console where developers can test APIs.

API Monetization

An API portal affords API providers the opportunity to monetize their APIs through customized licensing packages for partners and developers. Revenue can be maximized by offering service levels for each consumer’s unique business needs.

Akana API portal capabilities include:

  • Creating unique packages for different business needs.
  • Showing or hiding documents or elements based on license grants.
  • Enforcing quotas and service levels based on license types.

Personalized Dashboard and Notifications

Tying into the monetization aspect, an API portal also provides developers and partners with analytics tools that allow them to track business metrics for their APIs. These metrics can help identify areas for API optimization, growth, and new capabilities. You can:

  • View real-time API performance, usage metrics, and API health.
  • Monitor medium and long-term trends.
  • Build alert management, monitoring, and distribution.

Integrated API Lifecycle Management

With integrated API lifecycle management, you can guarantee consistent and accurate API production through all environments and stages of the software lifecycle. Built-in approval workflows ensure quality, which reduces the need for management and rework.

The Akana Community Manager can be configured to establish workflow processes with optional approval and activation steps for app and API administrators. The default workflow has the following settings:

  • Automatic approval and activation of requests to a sandbox API endpoint.
  • API administrator approval required for access to production endpoints.
  • App administrator activation required for production access.
  • API administrators can suspend and reactivate, or even cancel an app’s access to their API.

Experience the Akana API Portal

See how easy it is to create, document, test, publish, and market your APIs in the Akana API platform with a free 30-day trial.

Start Trial