Versions Compared

Key

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

...

  • bestIntegratorLink for a simple point of interaction defining the best way to get to content for that particular organization.

  • OA Status - for defining if the article is OpenAccess. You might use this to display some sort of “open access” icon in your interface, for example.

  • Article in context link (browzineWebLink) if you would like to provide a link to see the article in its originally published context within the BrowZine interface (all LibKey subscribers have access to BrowZine web as well which is needed for this link to appear/work).

  • Detailed breakdown of all available links (with the “best” one already pre-calculated in the aforementioned “bestIntegratorLink” value)

  • (If using the optional include) Information about the journal including a link to the journal in BrowZine and link to the cover image asset for inclusion in your interface as well as the SJR value of the journal.

The User Experience

So what happens when a user clicks a LibKey.io link that the API returns for “Download PDF” or “Article Link?” These are the content links designed to get the user directly to the content in an authorized way via their institution. While all LibKey links have a similar syntax they wind up forwarding to completely different URL’s based on the outcome of the LibKey link calculations. The most common user workflow however looks like this:

Click the LibKey Link → Organization’s SSO → Content

Thus if an organization’s SSO already has an activate session LibKey links have the potential (when they indicated “Download PDF” to be literally “one click to content!”

Examples

Tip

If you haven’t done so already, contact support@thirdiron.com to confirm your Library_ID and API_KEY which you need to try the following examples.

...