Date: Fri, 29 Mar 2024 09:10:24 +0000 (UTC) Message-ID: <1168767470.51.1711703424629@582364e6eb28> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_50_675656093.1711703424629" ------=_Part_50_675656093.1711703424629 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
The LibKey Article DOI or PMID Lookup Endpoint allows your appli= cation to determine whether an article is available at browzine.com= , and information about the article to produce a LibKey Direct PDF = Link as well as produce a link to the article within the c= ontext of the issue in BrowZine at your library.
Email us at support@thirdiron.com to request your A= PI Key. The Third Iron API can only be used by institutions subscribi= ng to the Third Iron Complete and LibKey Service.
There are two types of API Keys available:
Individual Library - A key to be used (and only authori= zed) for a subscribing institution.
Integration Partner - This =E2=80=9CUniversal=E2=80=9D = key can be used to access any subscribing Library ID with a single API Key = and pairs nicely with the Library Li= st Endpoint. This is useful for building applications that serve a larg= e number of different users with different institutional affiliations. Issu= ance of this type of key requires a license from Third Iron. Please contact= support@thirdiron.com for more details!
Submit a GET request against this endpoint with a DOI and your applicati= on will get a response indicating if that article can be found in the desig= nated library within BrowZine/LibKey. If the DOI or PMID matches an a= rticle in the Third Iron system, the response will contain an "Article Resu= lt" JSON object with metadata about the article reference by the specified = DOI or PMID.
Supported Methods |
GET |
---|---|
Endpoint Location |
/public= /v1/libraries/:library_id/articles/doi/:article_doi?access_token=3Dffffffff= -ffff-ffff-ffff-ffffffffffff -or- /public= /v1/libraries/:library_id/articles/pmid/:article_pmid?access_token=3Dffffff= ff-ffff-ffff-ffff-ffffffffffff |
Endpoint Parameters |
|
:library_id |
Replace the :library_id portion of the endpoint path with the id # of yo= ur library |
:article_doi |
Replace :article_doi with the DOI of an article. Only one DOI can be sup= plied. (DOI value does not need to be URI encoded) |
:article_pmid |
Replace :article_pmid with the pmid of an article. Only one pmid can be = supplied. |
Optional Includes |
|
?include=3Djournal |
Adding this include to your request will cause the response to include i= nformation about the journal that the DOI is located within. This inc= ludes the name of the journal, ISSN, SJR Value, Cover Image URL, BrowZine E= nabled Status and the Link to the Journal (more details below including exa= mple response) |
The LibKey Article DOI Lookup endpoint responds with a JSON object if th= e article is found in the LibKey system at all. If it i= s found, this indicates that LibKey recognizes this article DOI or PMID.&nb= sp; The accompanying metadata then will indicate if it is "availableThrough= BrowZine" for the given library. If it is, additional metadata about = the article, including the browzineWebLink is provided. The structur= e of the response overall is described in the following tables.
Property |
Type |
Description |
---|---|---|
data |
Object |
An Article Result object is returned if the DOI or PMID is recognized by= the Lookup Endpoint |
An article result represents an article that the LibKey system is aware = of. Responses from the "DOI/PMID lookup" endpoint then describe artic= les that have DOI/PMID's that LibKey is aware of but are not in the specifi= ed BrowZine Library (:library_id) as well as articles that are within that = library. A response indicates whether the article referenced by a DOI= /PMID is available at the specified library by setting the article result's= "availableThroughBrowZine" property to true when the article is available = at the library, and false when it is not.
The full list of properties that may appear on a journal result are desc= ribed in detail in the table below:
Property |
Type |
Description |
Optional |
---|---|---|---|
id |
number |
The article's unique id in the Third Iron system |
No |
type |
string |
has the value "articles" |
No |
title |
string |
The article's title |
Yes |
date |
string |
The date of the article |
No |
authors |
string |
The authors of the article |
Yes |
inPress |
boolean |
True when the article is not yet assigned to a regularly published issue= and is considered an "Article in Press". False when it is in a regularly p= ublished issue |
No |
doi |
string |
The DOI of the given record |
No |
linkResolverOpenUrl |
URL |
For libraries who have configured a link resolver or ILL system, this pr= operty will be available and could be used to provide a path for fulfillmen= t should no fullTextFile or contentLocation URLs be available. Optionally a library who does not have a link resolver or ILL s= ystem for LibKey to build a link for may request LibKey instead construct a= "mailto" which includes all the metadata for an article pointed at a speci= fic email address(es) to help the user request assistance in retrieving the= articles from the library. That information is held in this field as= well, even though it is not a URL but a "mailto". |
Yes |
pmid |
string |
For articles that have a PMID value it will be provided here |
Yes |
openAccess |
boolean |
True if the article is open access via the publisher and False if it is = not. LibKey.io links corresponding to this article which have an open= Access value of "True" will not include any institutional authentication.= p> |
No |
unpaywallUsable |
boolean |
True indicates that if the V1 API is used in conjunction with the Third = Iron produced =E2=80=9CDiscovery= Adapters=E2=80=9D, those adapters have a feature whereby a live unpayw= all service call can optionally be done to pick up accepted manuscripts. Ho= wever, since this call is live, Third Iron/LibKey may learn that an article= flagged by unpaywall actually should have a paywall. When this happens, th= is value becomes =E2=80=9Cfalse=E2=80=9D so that users of the discovery ada= pter don=E2=80=99t have the unpaywall live call script =E2=80=9Coverride=E2= =80=9D what Third Iron/LibKey know to be false. Third parties could potenti= ally use this value in the same way if they are using LibKey alongside Unpa= ywall=E2=80=99s API for more accurate data. |
No |
fullTextFile |
URL |
On articles where LibKey is aware of a path directly to the PDF file, th= is property will be available |
Yes |
contentLocation |
URL |
On articles where LibKey is aware of a path to the web page where the ar= ticle is available, this property will be available. This can include= non-publisher sources such as aggregators and repositories. |
Yes |
availableThroughBrowZine |
boolean |
True when the article is available within Browzine at the specified libr= ary |
No |
startPage |
string |
The page the article starts on |
Yes |
endPage |
string |
The page the article ends on |
Yes |
abstract |
string |
Abstract for the article if available |
Yes |
retractionNoticeUrl |
URL |
Will appear if the article has been retracted with a link to a LibKey.io= URL which provides more information about the retraction with data from Re= traction Watch. |
Yes |
browzineWebLink |
URL |
On titles that are BrowZine enabled, this property will be present and w= ill link to the article in the context of its issue (or articles in press l= ist as appropriate) on browzine.com |
No |
If you utilize the optional ?include=3Djournal parameter, you will also = receive journal information. The list of properties appearing when th= is is done is included below:
Property |
Type |
Description |
Optional |
---|---|---|---|
id |
number |
The journals's unique id in the Browzine system |
No |
type |
string |
has the value "journals" |
No |
title |
string |
The journals's title |
No |
issn |
string |
The ISSN value of the journal |
No |
sjrValue |
number |
The SJR (Scimago Journal Rank) value of the journal |
No |
coverImageUrl |
URL |
The link to the cover image |
No |
browzineEnabled |
boolean |
True when the journal is available within Browzine at the specified libr= ary |
No |
browzineWebLink |
URL |
On titles that are browzine enabled, this property will be present and w= ill link to the most current issue of the journal available to this library= |
Yes |
GET /pu= blic/v1/libraries/73/articles/doi/10.1056/NEJMe1702728?access_token=3Dfffff= fff-ffff-ffff-ffff-ffffffffffff
GET /pu= blic/v1/libraries/73/articles/pmid/28317425?access_token=3Dffffffff-ffff-ff= ff-ffff-ffffffffffff
{ "data": { "id": 76582654, "type": "articles", "title": "Assessment of Stable Coronary Lesions", "date": "2017-05-11", "authors": "Bhatt, Deepak L.", "inPress": false, =09=09"doi": "10.1056/NEJMe1702728", =09=09"pmid: "28317425", =09=09"openAccess": false, "fullTextFile": "https://libkey.io/libraries/73/articles/143256905/= full-text-file", =09=09"contentLocation": "https://libkey.io/libraries/73/articles/143256905= ", "availableThroughBrowzine": true, "startPage": "1879", "endPage": "1881", "browzineWebLink": "https://browzine.com/libraries/73/journals/1029= 2/issues/36167007?showArticleInContext=3Ddoi:10.1056/NEJMe1702728" } }
GET /pu= blic/v1/libraries/73/articles/doi/10.1056/NEJMe1708704?include=3Djournal&am= p;access_token=3Dffffffff-ffff-ffff-ffff-ffffffffffff
{ "data": { "id": 76582654, "type": "articles", "title": "Assessment of Stable Coronary Lesions", "date": "2017-05-11", "authors": "Bhatt, Deepak L.", "inPress": false, =09=09"doi": "10.1056/NEJMe1702728", =09=09"pmid: "28317425", =09=09"openAccess": false, "fullTextFile": "https://libkey.io/libraries/73/articles/143256905/= full-text-file", =09=09"contentLocation": "https://libkey.io/libraries/73/articles/143256905= ", "availableThroughBrowzine": true, "startPage": "1879", "endPage": "1881", "browzineWebLink": "https://browzine.com/libraries/73/journals/1029= 2/issues/36167007?showArticleInContext=3Ddoi:10.1056/NEJMe1702728" "relationships": { "journal": { "data": { "type": "journals", "id": 10292 } } } }, "included": [ { "id": 10292, "type": "journals", "title": "New England Journal of Medicine (NEJM)", "issn": "00284793", "sjrValue": 14.619, "coverImageUrl": "https://assets.thirdiron.com/images/covers/00= 28-4793.png", "browzineEnabled": true, "browzineWebLink": "https://browzine.com/libraries/73/journals/= 10292" } ] }