Helping Standardize How We Communicate About the API Integration Possibilities
Learn about a solution for listing the integrations possible with your API in a way that demonstrates its usefulness to others.
Join the DZone community and get the full member experience.Join For Free
Showcasing the integrations that are possible with your API via your API developer portal is an increasingly important way to demonstrate the usefulness of your API resources. Companies like Amazon, DataDog, Intercom, and other leading providers showcase other systems their solution is already integrated with. When it comes to API solutions, applications aren't just web and mobile, they are often system to system integrations with many of the SaaS and other software solutions that companies are already using in their operations.
As I do with other types of signals coming out of the API space, I'd like to see more API providers publish a listing of possible integrations, and I've created a simple API solution for managing an API integration page that can run in any Jekyll environment and possesses an API core. Using my approach to managing simple datasets, and publishing a human and machine interface using Github, I published an API integration page solution. Anyone can fork the project, reskin the look and feel of the website, and update the listing of integrations that are possible using a Google spreadsheet, then publishing the latest data using a Github repo and site.
My objective is to help API providers better manage and communicate the integrations that are possible via their API platform. I want them doing this in an organized and standardized way, helping their API consumers understand what is possible. I also want there to be a machine-readable definition of these integrations, so that analysts like me can more easily aggregate and connect the dots when it comes to what is possible with APIs. Right now, I am just tracking the URL of API providers integration pages, but I'd love it if the contents were also machine-readable and available via Github and API for forking and integration into other applications.
My API integration page and API template can be forked and run standalone, or you can copy the listing or icon pages, APIs, and YAML data core into a separate project. Each project has an OpenAPI defining the API surface area, and an APIs.JSON index for the entire project, as well as a YAML and JSON representation of API integrations present. I haven't had time to document everything 100%, so there is some awareness of Github, Jekyll, Liquid, and OpenAPI needed to get up and running.
Published at DZone with permission of Kin Lane, DZone MVB. See the original article here.
Opinions expressed by DZone contributors are their own.