Aspen API for Collection Spotlights

Resolved thelibrarian
(@thelibrarian)

1 year, 8 months ago

Hello,
Libraries that use Aspen are far more likely to utilize the collection spotlights to create bookrivers than the personal lists. Unfortunately it looks like Lists are the only option using the plugin’s API. Can you add a query to the collection spotlight API as well? Your plugin is MUCH nicer and functions better than the iframes in Aspen’s native bookrivers of their collection spotlight. I would really love to utilize the plugin with Aspen this way.

Viewing 7 replies - 1 through 7 (of 7 total)

Plugin Author photonicgnostic
(@photonicgnostic)

1 year, 8 months ago

Thank you for the compliment!

I can add support for the Search API which will allow you to make Bookshelves based on the same queries as the collection spotlights.

Thread Starter thelibrarian
(@thelibrarian)

1 year, 8 months ago

Wahoo thank you so much!!! A rookie question here–do you post here when you’ve done that? Or is it an update like a regular plugin updates?

Plugin Author photonicgnostic
(@photonicgnostic)

1 year, 8 months ago

It will be in the next plugin update, and I’ll mark this as resolved when I release the update.

Plugin Author photonicgnostic
(@photonicgnostic)

1 year, 7 months ago

Aspen Search API has been added in version 5.1.

Thread Starter thelibrarian
(@thelibrarian)

1 year, 7 months ago

Thank you!!!!

Thread Starter thelibrarian
(@thelibrarian)

1 year, 7 months ago

Hello,
I am sorry to bother you, but was wondering if I was doing this incorrectly. After updating the plugin I attempted to follow the instructions to embed a search that would display recently added new titles in my library. The url is https://roxbury.aspendiscovery.org/Search/Results?lookfor=%2A&searchIndex=Keyword&filter%5B%5D=availability_toggle%3A%22local%22&filter%5B%5D=format_category%3A%22Books%22&filter%5B%5D=target_audience%3A%22Adult%22&filter%5B%5D=format%3A%22Book%22&filter%5B%5D=local_time_since_added_roxbury%3A%22Month%22&filter%5B%5D=shelf_location%3A%22New%22&sort=relevance&view=list&searchSource=local

I also made it into a collection spotlight:
https://roxbury.aspendiscovery.org/API/SearchAPI?method=getCollectionSpotlight&id=93

I tried to follow your instructions and tried the following variations:

https://roxbury.aspendiscovery.org/API/SearchAPI?method=search&lookfor=%2A&searchIndex=Keyword&filter%5B%5D=availability_toggle%3A%22local%22&filter%5B%5D=format_category%3A%22Books%22&filter%5B%5D=target_audience%3A%22Adult%22&filter%5B%5D=format%3A%22Book%22&filter%5B%5D=local_time_since_added_roxbury%3A%22Month%22&filter%5B%5D=shelf_location%3A%22New%22&sort=relevance&view=list&searchSource=local

https://roxbury.aspendiscovery.org/API/SearchAPI?method=getListTitles&id=93

https://roxbury.aspendiscovery.org/API/SearchAPI?method=getCollectionSpotlight&id=93

I even tried one of the examples you had with my library’s info at the beginning:
https://roxbury.aspendiscovery.org/API/SearchAPI?method=search&filter%5B%5D=literary_form:Fiction&filter%5B%5D=publishDateSort:%5B2022%20TO%20*%5D&sort=days_since_added+asc

But nothing is working. To be clear, what I want to do is display the newest items purchased by my library in different categories: Adult Fiction, Adult Nonfiction, etc..

I must be doing something wrong and would greatly appreciate a nudge in the right direction. Thank you again for your incredible work.

Plugin Author photonicgnostic
(@photonicgnostic)

1 year, 7 months ago

You’re not doing anything wrong. It looks like you will need to ask your Aspen administrator to whitelist your website server IP.

You’ll want to use one of these URLs (ones that give you JSON data, not HTML):
https://roxbury.aspendiscovery.org/API/SearchAPI?method=getListTitles&id=93
OR
https://roxbury.aspendiscovery.org/API/SearchAPI?method=search&lookfor=%2A&searchIndex=Keyword&filter%5B%5D=availability_toggle%3A%22local%22&filter%5B%5D=format_category%3A%22Books%22&filter%5B%5D=target_audience%3A%22Adult%22&filter%5B%5D=format%3A%22Book%22&filter%5B%5D=local_time_since_added_roxbury%3A%22Month%22&filter%5B%5D=shelf_location%3A%22New%22&sort=relevance&view=list&searchSource=local

When I put them in my browser I get a message that my IP address is forbidden from accessing the API.

Viewing 7 replies - 1 through 7 (of 7 total)

The topic ‘Aspen API for Collection Spotlights’ is closed to new replies.