, an application programming interface (API) is an interface
that defines interactions between multiple software application
s or mixed hardware
-software intermediaries. It defines the kinds of calls
or requests that can be made, how to make them, the data format
s that should be used, the conventions to follow, etc. It can also provide extension mechanisms so that users can extend existing functionality in various ways and to varying degrees.
An API can be entirely custom, specific to a component, or designed based on an industry-standard to ensure interoperability
. Through information hiding
, APIs enable modular programming
, allowing users to use the interface independently of the implementation.
Reference to Web API
s is currently the most common use of the term.
There are also APIs for programming language
s, software libraries
, computer operating system
s, and computer hardware. APIs originated in the 1940s, though the term ''API'' did not emerge until the 1960s and 70s.
In building applications, an API (application programming interface) simplifies programming by abstracting
the underlying implementation and only exposing objects or actions the developer needs. While a graphical interface for an email client
might provide a user with a button that performs all the steps for fetching and highlighting new emails, an API for file input/output
might give the developer a function
that copies a file from one location to another without requiring that the developer understand the file system
operations occurring behind the scenes.
History of the term
The meaning of the term ''API'' has expanded over its history. It first described an interface only for end-user-facing programs, known as application program
s. This origin is still reflected in the name "application programming interface." Today, the term API is broader, including also utility software
and even hardware interfaces.
The idea of the API is much older than the term. British computer scientists Wilkes
worked on modular software libraries in the 1940s for the EDSAC
computer. Their book ''The Preparation of Programs for an Electronic Digital Computer
'' contains the first published API specification. Joshua Bloch
claims that Wilkes and Wheeler "latently invented" the API, because it is more of a concept that is discovered than invented.
The term "application program interface" (without an ''-ing'' suffix) is first recorded in a paper called ''Data structures and techniques for remote computer graphics
'' presented at an AFIPS
conference in 1968.
The authors of this paper use the term to describe the interaction of an application — a graphics program in this case — with the rest of the computer system. A consistent application interface (consisting of Fortran
subroutine calls) was intended to free the programmer from dealing with idiosyncrasies of the graphics display device, and to provide hardware independence
if the computer or the display were replaced.
The term was introduced to the field of database
s by C. J. Date
in a 1974 paper called ''The Relational
Approaches: Comparison of the Application Programming Interface''. An API became a part of ANSI/SPARC framework
for database management system
s. This framework treated the application programming interface separately from other interfaces, such as the query interface. Database professionals in the 1970s observed these different interfaces could be combined; a sufficiently rich application interface could support the other interfaces as well.
This observation led to APIs that supported all types of programming, not just application programming. By 1990, the API was defined simply as "a set of services available to a programmer for performing certain tasks" by technologist Carl Malamud
The conception of the API was expanded again with the dawn of web API
s. Roy Fielding
's dissertation ''Architectural Styles and the Design of Network-based Software Architectures'' at UC Irvine
in 2000 outlined Representational state transfer
(REST) and described the idea of a "network-based Application Programming Interface" that Fielding contrasted with traditional "library-based" APIs. XML
web APIs saw widespread commercial adoption beginning in 2000 and continuing as of 2021.
The web API is now the most common meaning of the term API.
When used in this way, the term API has some overlap in meaning with the terms communication protocol
and remote procedure call
The Semantic Web
proposed by Tim Berners-Lee
in 2001 included "semantic APIs" that recast the API as an open
, distributed data interface rather than a software behavior interface. Instead, proprietary
interfaces and agents became more widespread.
Libraries and frameworks
The interface to a software library
is one type of API. The API describes and prescribes the "expected behavior" (a specification) while the library is an "actual implementation" of this set of rules.
A single API can have multiple implementations (or none, being abstract) in the form of different libraries that share the same programming interface.
The separation of the API from its implementation can allow programs written in one language to use a library written in another. For example, because Scala
compile to compatible bytecode
, Scala developers can take advantage of any Java API.
API use can vary depending on the type of programming language involved.
An API for a procedural language
such as Lua
could consist primarily of basic routines to execute code, manipulate data or handle errors while an API for an object-oriented language
, such as Java, would provide a specification of classes and its class method
s are also APIs. By mapping the features and capabilities of one language to an interface implemented in another language, a language binding allows a library or service written in one language to be used when developing in another language.
Tools such as SWIG
and F2PY, a Fortran
interface generator, facilitate the creation of such interfaces.
An API can also be related to a software framework
: a framework can be based on several libraries implementing several APIs, but unlike the normal use of an API, the access to the behavior built into the framework is mediated by extending its content with new classes plugged into the framework itself.
Moreover, the overall program flow of control can be out of the control of the caller and in the framework's hands by inversion of control
or a similar mechanism.
An API can specify the interface between an application and the operating system
, for example, specifies a set of common APIs that aim to enable an application written for a POSIX conformant operating system to be compiled
for another POSIX conformant operating system.
and Berkeley Software Distribution
are examples of operating systems that implement the POSIX APIs.
has shown a strong commitment to a backward-compatible API, particularly within its Windows API
(Win32) library, so older applications may run on newer versions of Windows using an executable-specific setting called "Compatibility Mode".
An API differs from an application binary interface
(ABI) in that an API is source code based while an ABI is binary
based. For instance, POSIX
provides APIs while the Linux Standard Base
provides an ABI.
Remote APIs allow developers to manipulate remote resources through protocol
s, specific standards for communication that allow different technologies to work together, regardless of language or platform.
For example, the Java Database Connectivity API allows developers to query many different types of database
s with the same set of functions, while the Java remote method invocation
API uses the Java Remote Method Protocol to allow invocation
of functions that operate remotely, but appear local to the developer.
Therefore, remote APIs are useful in maintaining the object abstraction in object-oriented programming
; a method call
, executed locally on a proxy
object, invokes the corresponding method on the remote object, using the remoting protocol, and acquires the result to be used locally as a return value.
A modification of the proxy object will also result in a corresponding modification of the remote object.
Web APIs are the defined interfaces through which interactions happen between an enterprise and applications that use its assets, which also is a Service Level Agreement
(SLA) to specify the functional provider and expose the service path or URL for its API users. An API approach is an architectural approach that revolves around providing a program interface to a set of services to different applications serving different types of consumers.
When used in the context of web development
, an API is typically defined as a set of specifications, such as Hypertext Transfer Protocol
(HTTP) request messages, along with a definition of the structure of response messages, usually in an Extensible Markup Language (XML
) format. An example might be a shipping company API that can be added to an eCommerce-focused website to facilitate ordering shipping services and automatically include current shipping rates, without the site developer having to enter the shipper's rate table into a web database. While "web API" historically has been virtually synonymous with web service
, the recent trend (so-called Web 2.0
) has been moving away from Simple Object Access Protocol (SOAP
) based web services and service-oriented architecture
(SOA) towards more direct representational state transfer
(REST) style web resource
s and resource-oriented architecture
(ROA). Part of this trend is related to the Semantic Web
movement toward Resource Description Framework
(RDF), a concept to promote web-based ontology engineering
technologies. Web APIs allow the combination of multiple APIs into new applications known as mashup
In the social media space, web APIs have allowed web communities to facilitate sharing content and data between communities and applications. In this way, content that is created in one place dynamically can be posted and updated to multiple locations on the web.
For example, Twitter's REST API allows developers to access core Twitter data and the Search API provides methods for developers to interact with Twitter Search and trends data.
The design of an API has significant impact on its usage.
The principle of information hiding
describes the role of programming interfaces as enabling modular programming
by hiding the implementation details of the modules so that users of modules need not understand the complexities inside the modules.
Thus, the design of an API attempts to provide only the tools a user would expect.
The design of programming interfaces represents an important part of software architecture
, the organization of a complex piece of software.
APIs are one of the more common ways technology companies integrate. Those that provide and use APIs are considered as being members of a business ecosystem.
The main policies for releasing an API are:
: The API is for internal company use only.
: Only specific business partners can use the API. For example, vehicle for hire
companies such as Uber
allow approved third-party developers to directly order rides from within their apps. This allows the companies to exercise quality control by curating which apps have access to the API, and provides them with an additional revenue stream.
: The API is available for use by the public. For example, Microsoft
makes the Windows API
public, and Apple
releases its API Cocoa
, so that software can be written for their platforms
. Not all public APIs are generally accessible by everybody. For example, Internet service providers like Cloudflare or Voxility, use RESTful
APIs to allow customers and resellers access to their infrastructure information, DDoS stats, network performance or dashboard controls.
Access to such APIs is granted either by “API tokens”, or customer status validations.
Public API implications
An important factor when an API becomes public is its "interface stability". Changes to the API—for example adding new parameters to a function call—could break compatibility with the clients that depend on that API.
When parts of a publicly presented API are subject to change and thus not stable, such parts of a particular API should be documented explicitly as "unstable". For example, in the Google Guava
library, the parts that are considered unstable, and that might change soon, are marked with the Java annotation
A public API can sometimes declare parts of itself as ''deprecated'' or rescinded. This usually means that part of the API should be considered a candidate for being removed, or modified in a backward incompatible way. Therefore, these changes allow developers to transition away from parts of the API that will be removed or not supported in the future.
Client code may contain innovative or opportunistic usages that were not intended by the API designers. In other words, for a library with a significant user base, when an element becomes part of the public API, it may be used in diverse ways.
On February 19, 2020, Akamai
published their annual “State of the Internet” report, showcasing the growing trend of cybercriminals targeting public API platforms at financial services worldwide. From December 2017 through November 2019, Akamai witnessed 85.42 billion credential violation attacks. About 20%, or 16.55 billion, were against hostnames defined as API endpoints. Of these, 473.5 million have targeted financial services sector organizations.
API documentation describes what services an API offers and how to use those services, aiming to cover everything a client would need to know for practical purposes.
Documentation is crucial for the development and maintenance of applications using the API.
API documentation is traditionally found in documentation files but can also be found in social media such as blogs, forums, and Q&A websites.
Traditional documentation files are often presented via a documentation system, such as Javadoc or Pydoc, that has a consistent appearance and structure.
However, the types of content included in the documentation differs from API to API.
In the interest of clarity, API documentation may include a description of classes and methods in the API as well as "typical usage scenarios, code snippets, design rationales, performance discussions, and contracts", but implementation details of the API services themselves are usually omitted.
Restrictions and limitations on how the API can be used are also covered by the documentation. For instance, documentation for an API function could note that its parameters cannot be null, that the function itself is not thread safe
Because API documentation tends to be comprehensive, it is a challenge for writers to keep the documentation updated and for users to read it carefully, potentially yielding bugs.
API documentation can be enriched with metadata information like Java annotation
s. This metadata can be used by the compiler, tools, and by the ''run-time'' environment to implement custom behaviors or custom handling.
It is possible to generate API documentation in a data-driven manner. By observing many programs that use a given API, it is possible to infer the typical usages, as well the required contracts and directives. Then, templates can be used to generate natural language from the mined data.
Dispute over copyright protection for APIs
In 2010, Oracle Corporation sued Google for having distributed a new implementation of Java embedded in the Android operating system. Google had not acquired any permission to reproduce the Java API, although permission had been given to the similar OpenJDK project. Judge William Alsup
ruled in the ''Oracle v. Google'' case that APIs cannot be copyrighted
in the U.S and that a victory for Oracle would have widely expanded copyright protection to a "functional set of symbols" and allowed the copyrighting of simple software commands:
In 2014, however, Alsup's ruling was overturned on appeal to the Court of Appeals for the Federal Circuit
, though the question of whether such use of APIs constitutes fair use
was left unresolved.
In 2016, following a two-week trial, a jury determined that Google's reimplementation of the Java API constituted fair use
, but Oracle vowed to appeal the decision. Oracle won on its appeal, with the Court of Appeals for the Federal Circuit ruling that Google's use of the APIs did not qualify for fair use.
In 2019, Google appealed to the Supreme Court of the United States
over both the copyrightability and fair use rulings, and the Supreme Court granted review.
Due to the COVID-19 pandemic
, the oral hearings in the case were delayed until October 2020.
for the Macintosh
for Microsoft Windows
* Java APIs
for Microsoft Windows
cross-platform sound API
cross-platform API for general-purpose computing for CPUs & GPUs
cross-platform graphics API
API that supports multi-platform shared memory multiprocessing programming in C, C++, and Fortran on many architectures, including Unix and Microsoft Windows platforms.
* Server Application Programming Interface
* Simple DirectMedia Layer
*Common Object Request Broker Architecture
*Comparison of application virtual machines
*Document Object Model
*Foreign function interface
*Front and back ends
*Interface control document
*List of 3D graphics APIs
*Open Service Interface Definitions
*Software development kit
*Web content vendor
* Argues that "APIs are far from neutral tools" and form a key part of contemporary programming, understood as a fundamental part of culture.
Category: Technical communication