Welcome to the January Developer Community Newsletter.

Talis Aspire supports a variety of APIs for use by our customers, including the long-standing v1 ‘Classic’ APIs, and our more recent v2 JSON APIs.  For more information on all of these please see our support site.

Have you ever wanted to be able to create a ‘Bookmark in Talis Aspire’ button to instantly bookmark resources from your library catalogue, discovery system, or some other system containing resources that could be used on a reading list? This month we focus on the Bookmarklet API, which allows you to do just that.

Bookmarklet API

The Bookmarklet API falls into our ‘Classic’ APIs.  It enables the creation of web links which can quickly pre-populate a new resource bookmark for a user at the click of a button.  It follows the basic form:

http://<tenancyBaseUrl>/ui/forms/bookmarklet.html?<openUrlParams>

This will redirect the user to the Talis Aspire ‘create bookmark’ screen, pre-populating the fields with the params passed as  <openUrlParams>, following the OpenUrl spec.  See the Bookmarklet API spec for a full list of supported parameters.

For example, the following link will redirect the user to the bookmark creation screen on the Broadminster tenancy, pre-populated with the ISBN:
http://lists.broadminsteruniversity.org/ui/forms/bookmarklet.html?rft.isbn=0003223566

Additionally, passing the ISBN, LCN or DOI as a parameter will cause Talis Aspire to attempt to look up the resource in your library catalogue, or crossref, to extract a fuller metadata to populate the create bookmark screen.

This tooling allows the placement of direct bookmarking links within any tooling you may be using, such as catalogue web pages, or discovery services, enabling students to bookmark such pages without installing the Talis Aspire bookmarklet, and serving as a reminder that bookmarking of resources is a tool available to them.

A simple link embedded on your site might look something like this:

<a href=”http://lists.broadminsteruniversity.org/ui/forms/bookmarklet.html?rft.isbn=0003223566″>Add this resource</a>

Which would display a simple link with the title “Add this resource”.  When clicked this would direct the user to the create bookmark screen with the ISBN pre-populated, or with additional metadata added if the ISBN is found in Broadminster’s catalogue.

Alternatively we could style the link to be a clickable image instead:
<a href=”http://lists.broadminsteruniversity.org/ui/forms/bookmarklet.html?rft.isbn=0003223566″><img src=”http://mysite.com/addBookmarkButton.jpg”></a>

If you wanted to pass additional metadata along with the link, as fallback should the resource not be found in your catalogue, you can add it like so:

<a href=”http://lists.broadminsteruniversity.org/ui/forms/bookmarklet.html?rft.title=Essential Research Skills&rft.au=Bailey, Val&rft.pub=Collins Educational&rft.date=1995″><img src=”http://mysite.com/addBookmarkButton.jpg”></a>

More information on our APIs can be found on our support site, as can information on our LTI integrations.  For any queries on these tools, or to request API keys for the JSON (v2) APIs, please raise a support ticket.
 

Grow the Developer Community

If you have any colleagues who would also like to keep up to date with the latest integrations at Talis and receive this monthly newsletter, and other developer community posts, please email us at consulting@talis.com.