Metadata retrieval specifications


This page provides specification for the metadata retrieval API for the Article Sharing Framework (ASF) demonstrator developed by STM Solutions. The metadata retrieval API publicly exposes ASF-compliant license information as a function of DOI.

 

Retrieval API parameters

Caller provides

Data returned

Illustration example

DOI

All <license_ref> data and attributes for given DOI

?doi=<DOI>

license_url

All <license_ref> data and attributes for given DOI where the URL of the license(s) match the supplied license_url value

?doi=<DOI>&license_url=https://doi.org/10.15223/policy-001  

[or]

?doi=<DOI>&license_url=https%3A%2F%2Fdoi.org%2F10.15223%2Fpolicy-001

applies_to

All <license_ref> data and attributes for given DOI where the applies_to of the license(s) match the supplied applies_to value

?doi=<DOI>&applies_to=stm-asf

start_date

All <license_ref> data and attributes for given DOI where either of the following is true:

  • the start date of the license(s) is null/undefined;
  • the start date of the license(s) is before or equal* to the supplied start_date value

?doi=<DOI>&start_date=2021-09-28

* in other words, exclude licenses that start after the requested start date, representing licenses that are not yet active as of the requested date.  No start date means the license is active without further qualification. 

 

Return format
JSON or XML


Example response
https://api.asf-demo.stm-solutions.org/?doi=10.1021/acs.analchem.1c02400


Performance
The API is implemented on highly scalable and resilient cloud infrastructure, however without SLA or uptime guarantees.