APIful Blog We're obsessed with Web APIs


API Harmony now has an API

Oct 17, 2017 •

API Harmony now has its own API! We preached about the different types of APIs and their importance, about researching, documenting, managing, and monitoring APIs, as well as about selecting and using them. It’s about time we provide an API as well! In this post, we summarize the capabilities provided by the API, show how you can use it, and point to additional resources.

Capabilities

API Harmony’s API provides three capabilities:

  • Manage your APIs Expose your APIs (described using Open API Specifications) in your own, private instance of API Harmony. Doing so allows to securely promote your APIs within your organization and make use of API Harmony’s features like providing auto-generated code snippets or invoking APIs in our playground. Access to view your APIs is limited to members of your Bluemix organization.

  • Search Find public as well as your private APIs using API Harmony’s search capabilities. Search does not only target overall APIs, but also individual endpoints.

  • Advice Get usage advice for your source code (written in JavaScript, using jQuery or request). API Harmony will statically analyze your code, compare contained API requests against all known API specifications, and point to potential errors. Advice operations span all public APIs in API Harmony as well as those in the your Bluemix organization.

Tutorial

To use API Harmony’s API, you need a Bluemix account - sign up for one, if you have not done so before. Make sure you are logged into Bluemix.

Next, find API Harmony in the the Bluemix Catalog. API Harmony is an experimental service - to find it click on the “Bluemix Experimental Services” link at the far bottom of the catalog page. In the experimental services section, API Harmony is listed in the “Integrate” section.


Image 1: Find API Harmony in the IBM Bluemix Catalog

Next, provision an API Harmony instance by clicking on the service tile and following the instructions. From now on, this API Harmony instance can be accessed from your Bluemix dashboard. Once the instance is created, click “service credentials” to obtain the x-ibm-client-id and x-ibm-client-secret values to authenticate API requests. Send these values as headers in every API request.


Image 2: Provision an API Harmony instance and use the credentials in requests.

Further resources

To learn more about API Harmony’s own API and how to use it, check out the official API documentation in Bluemix.

Alternatively, check out the documentation within API Harmony itself - it does not get much more meta than that.

Finally, you can also check out API Harmony’s own OpenAPI Specification:

As always, let us know what you think about the experience - either in the comments below or by contacting us via Twitter.

Share via a Tweet or follow us for everything APIs!