...
| Code Block |
|---|
HTTP/1.1 429 Too Many Requests
X-Powered-By: Express
X-RateLimit-Limit: 2
X-RateLimit-Remaining: -1
X-RateLimit-Reset: 1489013242
Retry-After: 52
Content-Type: application/json; charset=utf-8
Content-Length: 183
ETag: W/"b7-900d271c"
Vary: Accept-Encoding
Date: Wed, 08 Mar 2017 22:46:30 GMT
Connection: keep-alive
{"status":429,"error":"rate_limit_exceeded","error_description":"Your API client has exceeded the allowed limit for requests. Please wait 52 seconds and try again.","retry_after":52} |
Entitlements Data Endpoints
BrowZine Search Endpoint
The BrowZine Search Endpoint allows your application to integrate with the search functionality that powers the search on browzine.com. Submit a GET request against this endpoint with a search query and your application will get a response representing the results that would be presented to a user if they were to perform that same search query within the journal/subject search of browzine.com. Responses contain an array of result objects of two types: journal results and subject area results. The array returned in the response is ordered according to relevance to the submitted search query using the same rules as the browzine.com search.
BrowZine Search Request:
...
| Code Block |
|---|
GET |
...
| Code Block |
|---|
/public/v1/libraries/:library_id/search |
...
Endpoint Parameters
...
Supply a querystring parameter of ?query=[searchQuery] where [searchQuery] is
a urlencoded representation of the search you wish to perform against your library's
journals and subject areas
...
The browzine search endpoint responds with a JSON object holding an array of result objects. This array is ordered by relevance to the search query. Like the search in browzine.com, there are two kinds of search results: journal results and subject results. Each journal result represents a publication that the library has some entitlement to, and each subject area result represents a taxonomic category in the browzine system that your library's collection has content within. The structure of the response overall and individual journal and subject results are described in the following tables and an example of search for "Bio" may also be found below.
Response Object:
...
An Array of Journal Result objects and Subject Result objects, sorted by relevance to the query,
may hold up to 250 results
...
Each journal result represents a journal that the queried library's collection has access to in some form that is revelent to the searched for query. Results include both titles that are BrowZine enabled and thus enjoy full TOC browsing support, the ability to add these titles to My Bookshelf and so on as well as Externally Linked titles that Browzine does not natively support, but that are found within the library's collection. Whether a title is supported by the browzine.com application is captured by the browzineEnabled property of the result object. Results for journals that are browzineEnabled at the queried library will have a browzineWebLink that links to the journal within browzine.com, and results for journals that are not browzineEnabled will have an externalLink property that links to the journal in the queried library's A-Z system if the queried library has been configured to integrate with the library's A-Z system. Each browzineEnabled journal result also provides a coverImageUrl that can be used to visually depict the journal within your application.
The full list of properties that may appear on a journal result are described in detail in the table below:
...
The journal's unique id in the Browzine system
...
No
...
Subject Result:
Each subject result represents a taxonomic category that the queried library's collection contains some publication within the category and whose name is relevant to the searched for query. Results include the name of the subject area and a link to the subject area in browzine.com.
...
Example Request:
| Code Block |
|---|
GET /public/v1/libraries/:library_id/search?query=Bio |
...
| Code Block |
|---|
{
"data": [
{
"id": 2911,
"type": "journals",
"title": "Biocatalysis and Agricultural Biotechnology",
"issn": "18788181",
"browzineEnabled": true,
"coverImageUrl": "https://assets.thirdiron.com/images/covers/1878-8181.png",
"sjrValue": 0
},
{
"id": 771,
"type": "subjects",
"name": "Biochemical and Biomolecular Engineering",
"browzineWebLink": "https://browzine.com/libraries/13/subjects/75/bookcases/146"
},
{
"id": 5006,
"type": "journals",
"title": "Biochemical Pharmacology",
"issn": "00062952",
"browzineEnabled": true,
"coverImageUrl": "https://assets.thirdiron.com/images/covers/0006-2952.png",
"sjrValue": 0
},
{
"id": 5016,
"type": "journals",
"title": "Biochemical Systematics and Ecology",
"issn": "03051978",
"browzineEnabled": true,
"coverImageUrl": "https://assets.thirdiron.com/images/covers/0305-1978.png",
"sjrValue": 0
},
...
]
} |
BrowZine Journal Availability Endpoint
The BrowZine Journal Availability Endpoint allows your application to determine whether a journal is available at browzine.com, and provides some basic information to help link to the journal within BrowZine at your library.
Submit a GET request against this endpoint with a search query and your application will get a response representing the results that would be presented to a user if they were to perform that same search query within the journal/subject search of browzine.com. Responses contain an array of result objects of two types: journal results and subject area results. The array returned in the response is ordered according to relevance to the submitted search query using the same rules as the browzine.com search.
BrowZine Journal Availability Request:
...
| Code Block |
|---|
GET |
...
| Code Block |
|---|
/public/v1/libraries/:library_id/search |
...
Endpoint Parameters
...
Supply a querystring parameter of ?issns=issn_list where issn_list is
a comma-delimited list of ISSNs (up to 50) without the dash
...
The browzine journal availability endpoint responds with a JSON object holding an array of journal result objects. This array is not necessarily in the same order as the order of ISSNs passed in. Each journal result represents a publication that the library has some entitlement to. The structure of the response overall and individual journal results are described in the following tables.
Response Object:
...
An Array of Journal Availability objects, sorted by relevance to the query,
may hold up to 50 results
...
Each journal result represents a journal that the queried library's collection has access to in some form that has an ISSN (or eISSN) passed in. Results include both titles that are BrowZine enabled (which allow full Table of Contents browsing), and titles external to Browzine, but within a library's purchased materials.
Whether a title is supported by the browzine.com application is captured by the browzineEnabled property of the result object. Results for journals that are browzineEnabled at the queried library will have a browzineWebLink that links to the journal within browzine.com, and results for journals that are not browzineEnabled will have an externalLink property that links to the journal in the queried library's A-Z system if the queried library has been configured to integrate with the library's A-Z system. Each browzineEnabled journal result also provides a coverImageUrl that can be used to visually depict the journal within your application.
The full list of properties that may appear on a journal result are described in detail in the table below:
...
The journal's unique id in the Browzine system
...
The issn for the journal that matches the issn passed in on the endpoint
(formatted with no hyphen)
...
No
...
Example Request:
| Code Block |
|---|
GET /public/v1/libraries/:library_id/search?issns=00280836,3940182X |
...
| Code Block |
|---|
{
"data": [
{
"id": 13191,
"type": "journals",
"title": "Nature",
"issn": "00280836",
"sjrValue": 21.936,
"coverImageUrl": "https://assets.thirdiron.com/images/covers/0028-0836.png",
"browzineEnabled": true,
"browzineWebLink": "http://browzine.com/libraries/222/journals/13191"
},
{
"id": 52627,
"type": "journals",
"title": "Consumer Reports",
"issn": "00107174",
"sjrValue": 0,
"coverImageUrl": "https://assets.thirdiron.com/images/covers/00107174.png",
"browzineEnabled": false,
"externalLink": "http://knownitem.search.edu/?jtitle=Consumer%3Reports&jissn=3940-182X"
}
]
} |
BrowZine Article DOI Lookup Endpoint
The BrowZine Article DOI Lookup Endpoint allows your application to determine whether an article is available at browzine.com, and provides some basic information to help link to the article within the context of the issue in BrowZine at your library.
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:
...
| Code Block |
|---|
GET |
...
| Code Block |
|---|
/public/v1/libraries/:library_id/articles/doi/:article_doi |
...
Endpoint Parameters
...
Replace :article_doi with the DOI of an article. Only one DOI can be supplied. (DOI value does not need to be URI encoded)
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:
...
An Article Result object is returned if the DOI is recognized by the BrowZine Article DOI Lookup Endpoint
...
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.
The full list of properties that may appear on a journal result are described in detail in the table below:
...
The journal's unique id in the Browzine system
...
The date of the article
...
Example Request:
| Code Block |
|---|
GET /public/v1/libraries/:library_id/articles/doi/10.1056/NEJMe1702728 |
...
| Code Block |
|---|
{
"data": {
"id": 76582654,
"type": "articles",
"title": "Assessment of Stable Coronary Lesions",
"date": "2017-05-11",
"authors": "Bhatt, Deepak L.",
"inPress": false,
"availableThroughBrowzine": true,
"startPage": "1879",
"endPage": "1881",
"browzineWebLink": "https://browzine.com/libraries/222/journals/10292/issues/36167007?showArticleInContext=doi:10.1056/NEJMe1702728"
}
} |