Over a million developers have joined DZone.

Building your API Developer Portal to embrace the API Economy

DZone's Guide to

Building your API Developer Portal to embrace the API Economy

· Integration Zone
Free Resource

The Integration Zone is brought to you in partnership with Cloud Elements. What's below the surface of an API integration? Download The Definitive Guide to API Integrations to start building an API strategy.

 An API Portal is one of the key architectural components of an effective API Management strategy, along with an API Gateway. They work together hand-in-hand. The API Portal allows developers to self-register and learn about your API, while the API Gateway is the "sharp edge" of your API Management solution, applying policies to API traffic in real-time.

Your APIs cannot be a "Field of Dreams" ("if we build it, they will come"). Instead, you must ensure that your API Portal is engaging, and facilitates developer self-service. This self-service starts right from the get-go, where you must allow developers to self-register:
As well as self-registering at the API Portal, developers must also be able to register their apps to use your APIs, and you must ensure that they have access to the APIs they need. Here we see how a developer has registered a mobile apps to consume APIs at an API Developer Portal:

Of course, unless your organization happens to be Axway itself, you will want to customize the API Developer Portal. I've written before about how to customize the Axway API Portal using its own API (yes, the Axway API Portal has an API of its own), using stylesheets and JSON. In this way, you can apply your own look and feel.

This Thursday I'll be presenting a Webinar about the API Portal, explaining how it fits within an overall API Management strategy, and walking through a practical example. I'll walk through the process whereby a developer discovers an API in the API Portal, and then uses it in an Android app. I'll walk through the Android example, showing what it means to consume an API using a mobile app. Registration is free - here is the sign-up URL: http://www.axway.com/events/event/webinar-building-your-developer-portal-go-soa-api-economy

Your API is not enough. Learn why (and how) leading SaaS providers are turning their products into platforms with API integration in the ebook, Build Platforms, Not Products from Cloud Elements.


Published at DZone with permission of Mark O'Neill, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}