Versions Compared

Key

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

...

This document is to help you connect your library's RB Digital collection to your Library Simplified circulation manager.

Getting Access

To start connecting connect your library's RB Digital account to your Library Simplified circulation manager, you will need to contact RB Digital and request a

  1. A "Basic Token"

  2. Library ID

Configuring Circulation Manager

must have two key data elements:

  1. RBdigital's numeric ID for the library

  2. An API access token

Finding the Numeric ID

Assuming the library has registered with RBdigital for service, you can find its RBdigital numeric id by searching the API with a non-authenticated request. Let's assume the library's name is "Somewhere County Library". You can copy the following URL into your web browser to submit the search request.

http://api.rbdigital.com/v1/suggestive/libraries?q=somewhere

You will receive a response that looks something like the following document. Obviously, this is just an example, with 'St' being a two-letter state abbreviation. If the distinctive portion of the name you search for is really distinctive, you may only receive one result; however, you may also receive multiple "similar" results as shown.

[
  {
    "url": "somewherest.rbdigital.com/",
    "id": "888",
    "category": "ST",
    "value": "somewhere-county-library",
    "label": "Somewhere County Library"
  },
  {
    "url": "somewheretx.rbdigital.com/",
    "id": "9999",
    "category": "TX",
    "value": "somewhere-public-library",
    "label": "Somewhere Public Library"
  }
]

Requesting an Access Token

RBdigital used basic HTTP authentication for securing access to its API. You will need an access token provided by RBdigital staff to facilitate the authentication in API requests. The "basic token" is a UUID value of the form AB71A495-49D1-2C8E-417A-EBB7FB66F51E. The exact letter values may be different, but the form will be the same.

The best method of communication to obtain the token is email. We've provided a basic email template you can use below (substitute your own library information as appropriate):

To: yoursupport@recordedbooks.com
From: youremail@somewherecounty.com
Subject: RBDigital API Credentials for SimplyE Partner Library

 Our library is implementing the SimplyE platform to provide aggregated access to our ebook and audiobook resources. In order to integrate our RBDigital collection, we need to obtain an access token (UUID). Specific library information is included below.

RBdigital numeric ID: 888

Somewhere County Library
123 W. Anywhere Ave.
Somewhere, ST 99999

Thank you for your assistance.

In case there is any confusion or problems, the street/mailing address will serve to uniquely identify the library.

Once you submit your email, you will receive an automated response with a case number within just a few minutes. Approximately one day later you can expect to receive a second email indicating your request has been escalated to the developer team for assistance. You can expect the response from the developers to take longer, perhaps several days. Because obtaining the access token can take a while, we recommend making the request as early in your implementation process as possible.

Configuring the Circulation Manager

  • Open a web browser and enter the URL to your Circulation Manager's Admin interface: for example, https://simplyeStep 1   Open a web browser and open your circulation manager admin interface.   This is you circulation manager URL with https://circulation.libraryname-state.org/admin  
  • Step 2   From In the top menu bar, click click System Configuration to  to enter into the the Configuration Manager portion  portion of the Admin interface.
    Image Modified
  • Step 3  Select Click the Collections item from the menu on the left and select left menu.
  • Click Create a new collection
    Image Modified
  • Step 4   Select the RBDigital item from the Protocol drop down field.

 

...

Image Added

  • Fill Step 5   Fill in the configuration form

    • Under Name, enter the collection Name (example: “RBDigital”) enter a descriptive phrase for the collection: for example, Somewhere County Library - RBdigital

    • Under Under Library Basic Token, enter token provided by RB DigitalRBdigital (as shown above)

    • Under Library UnderLibrary ID, enter the RBdigital library ID you found for your library ID provided by RB Digital

    • Under URL, enter your library circ manager URL

      Info
      titleOptional
      • OPTIONAL - Enter default loan period in days

      • OPTIONAL - Enter default reservation period in days

    • Click Submit

Image Removed

 

    • above

    Image Added
  • Add your library record to the configuration:
    • Select your library from the Add Library drop down list

    • (Optional, to assist in estimating hold/due periods) Enter a value in days into the Audiobook Loan Duration field

    • (Optional, as above) Enter a value in days into the Ebook Loan Duration field

    • Click the Add Library button to attach your library record to the collection

    Image Added
  • Click the Submit button to save the RBdigital collection configuration

...

Content by Label
showLabelsfalse
max5
spacesSIM
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel = "kb-how-to-article" and type = "page" and space = "SIM"
labelskb-troubleshooting-article

...