Versions Compared

Key

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

The BrowZine 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 Support to Request your API Key

Email us at support@thirdiron.com to request your API Key.  The BrowZine API can only be used by institutions subscribing to the BrowZine 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.  If the DOI matches the DOI of an article in the BrowZine system, the response will contain an "Article Result" JSON object with metadata about the article reference by the specified DOI.

BrowZine 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)

BrowZine Article DOI Lookup Response:

The BrowZine Article DOI Lookup endpoint responds with a JSON object if the article is found in the BrowZine system at all.  If it is found, this indicates that BrowZine 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.

Response Object:
PropertyTypeDescription
dataObject

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


Article Result:

An article result represents an article that the BrowZine system is aware of.  Responses from the "DOI lookup" endpoint then describe articles that have DOI's that BrowZine 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 journals's unique id in the Browzine system

No
typestringhas the value "journals"No
titlestringThe journals's titleNo
issnstringThe ISSN value of the journalNo
sjrValuenumberThe SJR (Scimago Journal Rank) value of the journalNo
coverImageUrlURLThe link to the cover imageNo
browzineEnabledbooleanTrue when the journal is available within Browzine at the specified libraryNo
browzineWebLinkURLOn titles that are browzine enabled, this property will be present and will link to the most current issue of the journal available to this libraryYes
Example Request, no include:
Code Block
languagetext
GET /public/v1/libraries/73/articles/doi/10.1056/NEJMe1702728

Example Response, no include:
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://browzine.com/libraries/73/articles/143256905/full-text-file",
        "availableThroughBrowzine": true,
        "startPage": "1879",
        "endPage": "1881",
        "browzineWebLink": "https://browzine.com/libraries/73/journals/10292/issues/36167007?showArticleInContext=doi:10.1056/NEJMe1702728"
    }
}


Example Request, with ?include=journal
Code Block
languagetext
GET /public/v1/libraries/73/articles/doi/10.1056/NEJMe1708704?include=journal

Example Response, with ?include=journal
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://browzine.com/libraries/73/articles/143256905/full-text-file",
        "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"
        }
    ]
}

...