In This Article

LibGuides API v1.2 endpoints

What is an API?

API stands for Application Programming Interface and it allows you to display and process your LibGuides CMS content outside of your system.

You must have advanced technical knowledge and coding skills.

They offer more flexibility than widgets, but they also require more extensive coding knowledge and are more complicated than just copying and pasting.

The v1.2 API endpoints include requests that allow you to create and update data. Please note: there is not a search API at this time.

Note: the API is only available to LibGuides CMS customers.

Available v1.2 endpoints

The following requests are available from:

  1. Go to Tools > Widgets from the command bar.
  2. Then click on the Endpoints v1.2 tab.
    1. For complete details on each action, click on the Details () icon for each request.
Action Method
Get A-Z assets GET
Update single A-Z asset PUT
Update A-Z asset collection PUT
Create single A-Z asset POST
Create A-Z asset collection POST

overview of v1.2 API endpoints

API Authentication

Before you can begin using the v1.2 endpoints, you must first create an access token for each application you intend to create. To create a new application (and manage existing ones):

  1. Go to Tools > Widgets from the command bar.
  2. Then click on the API Authentication tab.
  3. Click on the Create New Application button.
  4. On the Add/Edit Application modal set configure the application:
    1. Set the Application Name.
    2. Add an (optional) Application Description.
    3. Set the Scope of what can be accessed with the application to include/exclude:
      • Get list of A-Z assets
      • Create A-Z asset(s)
      • Update A-Z asset(s)
  5. Click Save to create the new application.

Once you have your access token, send it via the Authorization header in your request. For example:

POST /1.2/az/326762 HTTP/1.1
Authorization: Bearer ACCESSTOKEN

overview of creating a new api authentication, part 1

overview of creating a new api authentication, part 2

Related Articles