Versions Compared

Key

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

...

In version 1.0.1 of the Data API, it adds a feature allowing the client to request for token counts of volumes.

Use:

 

You can download the full text of certain specified volumes will be to use the HTRC Data API, with the volumeIDs of the desired volumes passed as parameters to the API, i.e. in the suffix of the URL of the API call (the suffix appended to the service endpoint constants of the API).  

Note: What are volumeIDs?

in the XML  returned by Solr API calls in HTRC, you will see such things as:

<str name="id">inu.30000054481001</str> 

<str name="id">yale.39002051005610</str>
...
etc.
Further below on this page (which you are currently reading), you will find examples of how to use suffixes with the Data API. 
 
A canonical path or usage example for the HTRC Data API that is currently available via a public-facing page within HTRC, is the one provided in the python file uncamputils.py that is a part of the zipped volumedownload.zip , available at: https://wiki.htrc.illinois.edu/pages/viewpage.action?pageId=15040514 . That file, uncamputils.py contains service endpoint constants for the Data API .
 
Please note, however, that the texts only of non-google-digitized public domain volumes are available via the Data API directly. So, this will work for you only if the volumes you identified via your Solr API query happen to belong to this category of volumes.

 

API

Note: all parameter values must be URL encoded

...

While the Data API by itself does not enforce any security mechanism for authentication and/or authorization, it is typically deployed behind an OAuth2 Servlet Filter.  A client making request to the Data API through the OAuth2 Servlet Filter must first obtain a valid OAuth2 token from the token service, and present the token as an additional HTTP request header to the OAuth2 Servlet Filtered Data API.  Please refer to " Using WSO2 Identity Server as the OAuth2 Provider for HTRC" for details on the usage.

...