The LibKey Article DOI or PMID 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 Third Iron Support to Request your API KeyEmail us at support@thirdiron.com to request your API Key. The Third Iron API can only be used by institutions subscribing to the 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 or PMID matches an article in the Third Iron system, the response will contain an "Article Result" JSON object with metadata about the article reference by the specified DOI or PMID.
Third Iron Journal Availability Request:
| Supported Methods | |
|---|
| Endpoint Location |
| Code Block |
|---|
/public/v1/libraries/:library_id/articles/doi/:article_doi |
-or-
| Code Block |
|---|
/public/v1/libraries/:library_id/articles/pmid/:article_pmid |
|
|---|
Endpoint Parameters |
|
|---|
| :library_id | Replace 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) |
|---|
| :article_pmid | Replace :article_pmid with the pmid of an article. Only one pmid can be supplied. |
|---|
| Optional Includes |
|
|---|
| ?include=journal | Adding 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 or PMID Lookup Response:
The LibKey Article DOI Lookup endpoint responds with a JSON object if the article is found in the LibKey system at all. If it is found, this indicates that LibKey recognizes this article DOI or PMID. 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:
| Property | Type | Description |
|---|
| data | Object | An Article Result object is returned if the DOI or PMID is recognized by the Lookup Endpoint |
Article Result:
An article result represents an article that the LibKey system is aware of. Responses from the "DOI/PMID lookup" endpoint then describe articles that have DOI/PMID's that 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/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.
...
| 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 library | No |
| browzineWebLink | URL | On titles that are browzine enabled, this property will be present and will link to the most current issue of the journal available to this library | Yes |
Example Request, no include for DOI:
| Code Block |
|---|
|
GET /public/v1/libraries/73/articles/doi/10.1056/NEJMe1702728 |
Example Request, no include for PMID
| Code Block |
|---|
|
GET /public/v1/libraries/73/articles/pmid/28317425 |
Example Response, no include (for either request above):
| Code Block |
|---|
|
{
"data": {
"id": 76582654,
"type": "articles",
"title": "Assessment of Stable Coronary Lesions",
"date": "2017-05-11",
"authors": "Bhatt, Deepak L.",
"inPress": false,
"doi": "10.1056/NEJMe1702728",
"pmid: "28317425",
"openAccess": false,
"fullTextFile": "https://libkey.io/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"
}
} |
Example Request, with ?include=journal
| Code Block |
|---|
|
GET /public/v1/libraries/73/articles/doi/10.1056/NEJMe1708704?include=journal |
Example Response, with ?include=journal
| Code Block |
|---|
|
{
"data": {
"id": 76582654,
"type": "articles",
"title": "Assessment of Stable Coronary Lesions",
"date": "2017-05-11",
"authors": "Bhatt, Deepak L.",
"inPress": false,
"doi": "10.1056/NEJMe1702728",
"pmid: "28317425",
"openAccess": false,
"fullTextFile": "https://libkey.io/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"
"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"
}
]
} |
...