Welcome to NLBSG!

This gem interacts with the Singapore National Library (NLB) API.

More information on accepted parameters and responses are available at https://opendata.nlb.gov.sg/content/SkillsFuture/NLB_Labs_TechDoc-V3.6.pdf

Obtain an API key at

https://www.nlb.gov.sg/GetInvolved/ContributeCreate/NLBlabs.aspx

Add this line to your application's Gemfile:

gem 'nlbsg'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install nlbsg

Use your own API Key as NLBSG_KEY

client = NLBSG.client(key: NLBSG_KEY, env: :production)

The Search method requires at least one parameter below and looks for books in the NLB database matching the search criteria.

client.search(title: "search string")

The Get Availability Info method requires at least one parameter below and checks whether a book is available for loaning.

client.get_availability_info(BID: "BID string")

The Get Title Details method requires at least one parameter below and returns with more details on the specified title.

client.get_title_details(BID: "BID string")

Bug reports and pull requests are welcome on GitHub at https://github.com/pest-control/nlbsg.

The gem is available as open source under the terms of the MIT License.