In the technology industry, the term “API” is very widely used. Unfortunately, different people and organizations sometimes mean different things when they use the term, which can lead to misunderstanding and failed communication. This page aims to clarify both what an API is, and what it isn’t, when referred to in a Skyward context.
API is an acronym, which stands for Application Programming Interface. Here is a well thought-out definition of an API, according to Wikipedia:
An application programming interface (API) is a computing interface to a software component or a system, that defines how other components or systems can use it. It defines the kinds of calls or requests that can be made, how to make them, the data formats that should be used, the conventions to follow, etc. … An API can be entirely custom, specific to a component, or it can be designed based on an industry standard to ensure interoperability.
Sometimes, people use the term API more loosely, with a more general meaning of an interface between two systems. To avoid ambiguity and confusion, in the context of Skyward applications interoperating with other applications, when we use the term API, we mean that we are providing an interface within our application for other applications to connect to and interoperate with us in real time. Here are some specific examples of how this terminology should and shouldn’t be used:
In both of our products (SMS 2.0 and Qmlativ), we provide a OneRoster API. This API allows other applications to connect to a Skyward application to request a wide range of student information or update assignment grades using the rules spelled out in the industry standard OneRoster specification. We say that we provide, have, or offer a OneRoster API, because we have written an interface in our application that allows other applications to connect to us.
Another good example is Ed-Fi. In this case, a third-party, often affiliated with a state education agency, will provide an API for school districts to upload their student information using the rules spelled out in the Ed-Fi standard for communication. In this example, it is the state education agency that provides, has, or offers the Ed-Fi API, and the Skyward applications support or consume it. We could also say that Skyward provides, has, or offers an API Client for the Ed-Fi API, though this terminology is less common. The key difference here is the Skyward applications do not contain an interface for anyone to connect to our application to send or request data using the Ed-Fi standard, therefore we do not provide, have, or offer an Ed-Fi API. We connect to other application’s Ed-Fi APIs to send information, therefore we support or consume the Ed-Fi API.
A final example is a file import and/or export. In these types of interfaces, a file in a mutually agreed upon format (CSV, XML, Fixed, etc.) is either exported from Skyward applications and sent to another application or exported from other applications and imported into the Skyward application. Both SMS 2.0 and Qmlativ contain many of these types of interfaces. In this case there is no connection being made between the Skyward application and any other application, so the interface is not an API. We use the terms import and export to describe the interface, so it is clearly understood that there is no connection between systems or real time transfer of data involved.
API: Functionality added to an application that allows other applications to connect to it to exchange data in real time
API Client: Functionality added to an application that allows it to connect to other applications to exchange data in real time
File Export: Functionality added to an application that allows data to be saved to a file, often to be sent to another application.
File Import: Functionality added to an application that allows data to be read in from a file, often obtained from another application.
Interface: A generic term for any means for multiple applications to interoperate with each other. APIs, API Clients, File Exports, and File Imports are all examples of Interfaces.