REST API Model
The E-Link 2 online documentation details the various endpoints for use in submission of record metadata, media, and historical queries using the standard GET, POST, PUT, and DELETE operations as required. While the E-Link 1 APIs made use of the HTTP BASIC username-and-password authentication for access, the new system will instead employ the use of user-generated API keys in the Authorization header for each request. The following section shows an example of E-Link 1 XML record update as opposed to the function in E-Link 2 JSON. Hovering over the left side highlighted sections will indicate the JSON equivalent on the right.
E-Link 2 API Python Library
For E-Link 2, OSTI has created a Python library that provides an interface to the E-Link 2 API to facilitate integration to any systems developed in Python.
API Examples
Detailed example use cases: