Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The BrowZine LibKey Article DOI Lookup Endpoint allows your application 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 context of the issue in BrowZine at your library.

Note

Contact

BrowZine

Third Iron Support to Request your API Key

Email us at support@thirdiron.com to request your API Key.  The BrowZine Third Iron API can only be used by institutions subscribing to the BrowZine Third Iron Complete and LibKey Service.

Submit a GET request against this endpoint with a DOI and your application will get a response indicating if that article can be found in the designated library within BrowZine/LibKey.  If the DOI matches the DOI of an article in the BrowZine Third Iron system, the response will contain an "Article Result" JSON object with metadata about the article reference by the specified DOI.

...

Third Iron Journal Availability Request:

Supported Methods


Code Block
GET


Endpoint Location


Code Block
/public/v1/libraries/:library_id/articles/doi/:article_doi


Endpoint Parameters


:library_idReplace the :library_id portion of the endpoint path with the id # of your library
:article_doi

Replace :article_doi with the DOI of an article. Only one DOI can be supplied. (DOI value does not need to be URI encoded)

Optional Includes
?include=journalAdding this include to your request will cause the response to include information about the journal that the DOI is located within.  This includes the name of the journal, ISSN, SJR Value, Cover Image URL, BrowZine Enabled Status and the Link to the Journal (more details below including example response)

...

LibKey Article DOI Lookup Response:

The BrowZine LibKey Article DOI Lookup endpoint responds with a JSON object if the article is found in the BrowZine LibKey system at all.  If it is found, this indicates that BrowZine LibKey recognizes this article DOI.  The accompanying metadata then will indicate if it is "availableThroughBrowZine" for the given library.  If it is, additional metadata about the article, including the browzineWebLink is provided.   The structure of the response overall is described in the following tables.

...

PropertyTypeDescription
dataObject

An Article Result object is returned if the DOI is recognized by the BrowZine LibKey Article DOI Lookup Endpoint

...

An article result represents an article that the BrowZine LibKey system is aware of.  Responses from the "DOI lookup" endpoint then describe articles that have DOI's that BrowZine LibKey is aware of but are not in the specified BrowZine Library (:library_id) as well as articles that are within that library.  A response indicates whether the article referenced by a DOI 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.

...

PropertyTypeDescriptionOptional
idnumber

The article's unique id in the Browzine Third Iron system

No
typestringhas the value "articles"No
titlestringThe article's titleYes
datestring

The date of the article

No
authorsstringThe authors of the articleYes
inPressbooleanTrue 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 published issueNo
fullTextFileURLOn articles where BrowZine LibKey is aware of a path directly to the PDF file, this property will be availableYes
contentLocationURLOn articles where LibKey is aware of a path to the web page where the article is available, this property will be available.  This can include non-publisher sources such as aggregators and repositories.Yes
availableThroughBrowZinebooleanTrue when the article is available within Browzine at the specified libraryNo
startPagestringThe page the article starts onYes
endPagestringThe page the article ends onYes
browzineWebLinkURLOn titles that are browzine BrowZine enabled, this property will be present and will link to the article in the context of its issue (or articles in press list as appropriate) on browzine.comNo

...

Code Block
languagetext
{
    "data": {
        "id": 76582654,
        "type": "articles",
        "title": "Assessment of Stable Coronary Lesions",
        "date": "2017-05-11",
        "authors": "Bhatt, Deepak L.",
        "inPress": false,
        "fullTextFile": "https://browzinelibkey.comio/libraries/73/articles/143256905/full-text-file",
		"contentLocation": "https://libkey.io/libraries/73/articles/143256905",
        "availableThroughBrowzine": true,
        "startPage": "1879",
        "endPage": "1881",
        "browzineWebLink": "https://browzine.com/libraries/73/journals/10292/issues/36167007?showArticleInContext=doi:10.1056/NEJMe1702728"
    }
}

...

Code Block
languagetext
{
    "data": {
        "id": 143256905,
        "type": "articles",
        "title": "From Last to First — Could the U.S. Health Care System Become the Best in the World?",
        "date": "2017-09-07",
        "authors": "Schneider, Eric C.; Squires, David",
        "inPress": false,
        "fullTextFile": "https://browzinelibkey.comio/libraries/73/articles/143256905/full-text-file",
		"contentLocation": "https://libkey.io/libraries/73/articles/143256905",
        "availableThroughBrowzine": true,
        "startPage": "901",
        "endPage": "904",
        "browzineWebLink": "https://browzine.com/libraries/73/journals/10292/issues/99568218?showArticleInContext=doi:10.1056/NEJMp1708704",
        "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/0028-4793.png",
            "browzineEnabled": true,
            "browzineWebLink": "https://browzine.com/libraries/73/journals/10292"
        }
    ]
}

...