Skip to main content
Help Center

Setting Up a Live API Integration

A live API integration connects ePlatform to a supported Library Management System (LMS). Once configured, ePlatform catalogue records can be synchronised with your existing library catalogue.

The integration must first be enabled by ePlatform Support. Your library will then receive the credentials and setup instructions required for its Library Management System.

What the live API does

The live API supplies ePlatform catalogue information to your Library Management System. This can allow students to discover eBooks and Audiobooks alongside physical titles in your existing library catalogue.

The supplied catalogue information can include:

  • title;
  • author;
  • ISBN;
  • format; and
  • a discovery or borrowing link that opens the title in ePlatform.

When the LMS resource sync is configured, it can automatically add new ePlatform titles and remove records when the corresponding licences expire.

The API manages catalogue discovery. It does not change ePlatform borrowing rules, loan durations, patron permissions, or loan limits.

Before you begin

Confirm that you have:

  • the name of your Library Management System;
  • access to its integration or resource-sync settings;
  • a staff member or system administrator who can configure the LMS; and
  • approval to request API credentials for your ePlatform library.

The repository currently documents live API setup resources for Softlink Oliver and Accessit Library. Contact ePlatform Support to confirm whether an integration is available for another system.

Request the integration

  1. Submit a support request or email support@eplatform.co.
  2. Include your ePlatform library name.
  3. Provide the name of your Library Management System.
  4. Ask for the live API integration to be enabled.
  5. Include the contact details of the person coordinating the setup.

ePlatform Support will confirm whether the connection is available and provide the relevant setup information.

Receive your API credentials

Once the integration has been enabled, ePlatform Support will provide a unique:

  • Client ID; and
  • Client Secret.

These credentials connect your Library Management System to your library’s ePlatform catalogue data.

Keep the Client ID and Client Secret secure. Only provide them to staff responsible for configuring the integration.

Configure your Library Management System

Follow the system-specific setup instructions supplied by ePlatform Support. The exact settings and navigation depend on the Library Management System being used.

The repository currently identifies the following setup resources:

  • Softlink Oliver: How to Set Up Wheelers ePlatform in Oliver Build 8.
  • Accessit Library: V9 Library Setup – Wheelers ePlatform API Configuration and Resource Sync Setup.

If you use another LMS, contact ePlatform Support for the setup information available for that system.

Complete the resource-sync configuration

  1. Open the integration or resource-sync settings in your LMS.
  2. Follow the system-specific instructions provided by ePlatform Support.
  3. Enter the supplied Client ID and Client Secret where instructed.
  4. Complete the resource-sync configuration described in the guide.
  5. Run or activate the sync using the instructions for your LMS.

Do not substitute settings from a different Library Management System. Use the guide supplied for the system your library operates.

Test the integration

Test the connection before announcing that ePlatform titles are available through your Library Management System.

  1. Complete the resource sync in your LMS.
  2. Search the LMS catalogue for several ePlatform titles.
  3. Confirm that the expected title information appears.
  4. Confirm that the title is identified as an eBook or Audiobook.
  5. Open the discovery or borrowing link.
  6. Confirm that the link opens the correct title in ePlatform.
  7. Repeat the test with several different titles.

If a patron is asked to sign in after opening the link, they must use the authentication method configured for your ePlatform library.

How the ongoing sync works

After the live API and resource sync are configured:

  • newly purchased ePlatform titles can be added to the LMS catalogue;
  • catalogue information can be supplied through the connection; and
  • records can be removed when the corresponding licences expire.

This automated maintenance helps prevent catalogue links from remaining available after an ePlatform title is no longer accessible.

A separate manual MARC export is not required for titles managed through the configured API resource sync.

If the integration is not working

If the resource sync does not return the expected titles:

  1. Confirm that the API has been enabled for your ePlatform library.
  2. Confirm that the supplied Client ID and Client Secret were entered as instructed.
  3. Review the system-specific setup guide provided by ePlatform Support.
  4. Record any error message displayed by your LMS.
  5. Contact ePlatform Support with the test results.

Need help?

If you cannot configure or test the live API, submit a support request or email support@eplatform.co.

Include:

  • your ePlatform library name;
  • the name of your Library Management System;
  • the setup guide you followed;
  • the stage of the configuration you reached; and
  • the error message displayed, if any.