API Building Blocks
The current API movement has been built on existing web technologies, using HTTP to transmit valuable business resources, via meaningful, descriptive URL endpoints. When anyone talks about APIs or Application Programming Interfaces, the conversation is immediately dominated by technical jargon, arguing about the finer points of HTTP or REST--while in reality there are many more building blocks that go into a successful API.
After reviewing the 6000+ APIs available in the ProgrammableWeb API directory, patterns begin to emerge of the building blocks that are used by the successful APIs. I have compiled a list these building blocks in a whitepaper called, The Building Blocks of a Successful API, as well as providing access to some of the information available in the white paper below.
Technology |
|
User Management |
|
Deployment |
|
Methodology |
|
Content Management System |
|
Onboarding |
|
Definitions |
|
|
|
|
Data |
|
Documentation |
|
Authentication |
|
File Management |
|
Images & Photos |
|
Code |
|
Custom |
|
Mobile |
|
API |
|
Self-Service Support |
|
Commerce |
|
Direct Support |
|
Communications |
|
Virtual Commerce |
|
Updates |
|
Monetization |
|
Service Levels |
|
Ranking |
|
Advertising |
|
Monetization |
|
Resources |
|
Communication |
|
Calendar |
|
Research & Development |
|
Posts |
|
Legal |
|
Embeddable |
|
Friends |
|
Environment |
|
Links |
|
Developer Account |
|
Geo |
|
Gaming |
|
Reciprocity |
|
Security |
|
Availability |
|
Deployment |
|
|
|
|
Environment |
|
Utility |
|
Analytics |
|
Mobile Devices |
|
Reader Devices |
|
Mobile Platforms |
|
Automation |
|
|
|
|
Languages |
|
Support |
|
Pricing |
|
Marketplace |
|
Social |
|
Desktop |
|
Enterprise |
|
Application |
|
Application Frameworks |
|
Productivity |
|
User Interface |
|
Marketing |
|
Not all these building blocks are applicable to every API, but each one should be considered when planning a new API or deploying the next version of an existing API. My goal is to not to provide the details of implementing each of these building blocks, but to highlight the full spectrum of building blocks used by the successful APIs on the Internet today.
Developers have grown familiar with consistency across many of these public APIs. The patterns found in many of these API areas is an organic process that has happened from waves of API owners emulating the successful APIs prior to them. This cycle reflects the organic nature of the web API movement which started in the early 2000’s and has picked up significant momentum by 2010.
The Building Blocks of a Successful API is not meant to define a standard for API areas, but to shed light on what approaches are working in the space. Something you will find in the white paper version of The Building Blocks of a Successful API are several appendixes to assist with planning, designing and deploying successful APIs.
Technical building blocks are only the beginning of a successful API, after that proper business and legal building blocks, as well as an energetic evangelism strategy are critical to a successful API.
