Harvard IT's architectural layers and guidance for interoperation and data state that:
- APIs are the preferred method of moving information between systems at Harvard.
- Open standards ease interoperation, facilitate broader adoption and reduce vendor lock-in.
- All data assets must be documented with descriptions and easily available to members of the Harvard Community.
Harvard's API Platform supports these three foundations for interoperability, and as such is relied on by a large community of Harvard developers. Hundreds of developers on 30+ teams throughout Harvard are using the API platfform to keep their apps secure and flexible. Harvard's API ecosystem and API catalog have enabled the launch of myriad apps, integrations, features and projects. You can learn about some examples in the "success stories" section of this website.
By using APIs, developers achieve a simpler, more flexible architecture and faster time-to-market for their apps. Examples of apps and integrations which have benefited from API-driven approaches include the Crimson Clear app, the Person Data Service, the e-Commerce Gateway, and the Buy-to-Pay project.
There are two main types of developers using the Harvard API Platform:
(1) API Consumers - developers who need access to APIs to develop their apps, integrations, or websites. API Consumers can get started right away by using Harvard's API marketplace at API Portal.
(2) API Producers - developers who build and publish general-purpose APIs, which are of value to the Harvard community. API Producers can get started by following these steps:
- email apihelp@harvard.edu to request an orientation session
- review Harvard's API Community wiki in confluence to become familiar with the API Platform
- confirm access to the API Platform developers console and begin building your API proxies and API products
If you're a developer who's interested in getting started with APIs and data at Harvard, below are a few resources to help you begin.
Note: some of these resources may require HarvardKey authentication.
- If you're developing an app, website or integration which needs access to administrative data, you can browse available APIs, review documentation, and register your app in the API portal. When doing so, be sure to select the API(s) you need access to by clicking on "request" or "enable" to the right of the APIs you need for your app.
- If you're an API "product owner" (ie, you or your team develop API products for use by others), and are interested in publishing your APIs in the API portal, please contact apihelp@harvard.edu. Some of the benefits of doing so include more secure implementations, simplified provisioning of keys, improved discoverability, the ability to implement policies, and robust logging and metrics for your API.
- For API producers (API developers), the API platform can simplify and accelerate the process of securing your API, implementing rate limiting or mediation processes, and documenting your API for interested parties. If you are interested in using the API platform to manage your APIs, please reach out to apihelp@harvard.edu.
- If you're interested in accessing the Harvard Dataverse data for your research purposes, for visualizations, or for your app or website, check out the Harvard Dataverse
- If you need access to business glossaries and data dictionaries for administrative data, take a look at Harvard's Interactive Library of Data Assets