Skip to main content
Help Center

Using SIP2 for Patron Authentication

SIP2 allows patrons to sign in to ePlatform using credentials held by a compatible Library Management System (LMS).

The SIP2 service and connection details are supplied by your LMS provider. Configuration requires coordination between the provider, your IT team, and ePlatform Support.

How SIP2 authentication works

SIP2 connects ePlatform to the patron authentication service provided through your Library Management System.

When a patron signs in, ePlatform uses the SIP2 connection to verify the credentials held by the LMS.

This allows patrons to use their existing library credentials instead of a separately managed ePlatform username and password.

Before you begin

Confirm that:

  • your Library Management System supports SIP2 authentication;
  • your LMS provider can supply a SIP2 service;
  • you have a contact at the LMS provider who can assist with the connection;
  • your IT team can assist with network or firewall requirements; and
  • you have two or three patron accounts available for testing.

SIP2 is supplied by your Library Management System provider, not by ePlatform. Contact the provider before requesting the ePlatform configuration.

Request SIP2 details

Ask your Library Management System provider to enable SIP2 and supply the connection information required for an external service.

The required information includes the SIP2:

  • connection credentials;
  • server address or IP address; and
  • connection port.

Your LMS provider should also confirm any firewall or IP allowlisting requirements for the SIP2 service.

Provide the connection details

After receiving the SIP2 information from your LMS provider:

  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. Provide the SIP2 server address or IP address and port.
  5. Confirm which organisation or provider is hosting the SIP2 service.
  6. Ask ePlatform Support how the SIP2 credentials should be supplied securely.

Do not include sensitive connection credentials in a public help request or other publicly visible message.

Complete the firewall configuration

A SIP2 connection may require IP addresses or ports to be allowed through a firewall.

ePlatform Support, your IT team, and your LMS provider will need to confirm:

  • the SIP2 server address;
  • the SIP2 connection port;
  • which ePlatform connection details must be allowed by the LMS environment; and
  • which server details must be allowed for the ePlatform connection.

Complete the required firewall changes before testing the patron sign-in.

Test SIP2 authentication

Test the connection with two or three patron accounts before providing SIP2 sign-in instructions to all patrons.

  1. Confirm that the first test account can sign in to the Library Management System using its existing credentials.
  2. Open your library’s ePlatform sign-in page.
  3. Use the configured SIP2 login method.
  4. Enter the same patron credentials.
  5. Confirm that the patron reaches the correct ePlatform library.
  6. Browse or search for an available eBook or Audiobook.
  7. Borrow the title.
  8. Open the title and confirm that reading or playback begins.
  9. Repeat the test with the remaining accounts.

Record any error message displayed and whether the problem affects one test account or every account.

Forgotten passwords

SIP2 credentials are managed by the connected Library Management System. ePlatform administrators do not reset these credentials as manually managed ePlatform passwords.

If a patron forgets their password, they should use the password-recovery process provided by your library or LMS.

If the patron can sign in to the LMS but cannot sign in to ePlatform, test another patron account and contact ePlatform Support with the results.

SIP2 and catalogue integration

SIP2 is used for patron authentication. It does not add ePlatform title records to your Library Management System catalogue.

To make ePlatform titles discoverable in your LMS, use either:

  • a supported live API catalogue integration; or
  • manually exported MARC records.

If SIP2 authentication is not working

  1. Confirm that the test account can sign in to the LMS.
  2. Confirm that the SIP2 service has been enabled by the LMS provider.
  3. Confirm the SIP2 server address and port.
  4. Ask your IT team and LMS provider to review the firewall requirements.
  5. Record the error message displayed during the ePlatform sign-in attempt.
  6. Repeat the test with another patron account.

Frequently asked questions

The SIP2 authentication test succeeded, but patrons still cannot sign in. What should I do?

Contact ePlatform Support. Include your library name, Library Management System, the affected sign-in method, the result of the authentication test, and any error shown to patrons. ePlatform Support will investigate or advise whether your LMS provider needs to assist. Do not include patron passwords.

Need help?

If the SIP2 connection cannot be configured or tested successfully, submit a support request or email support@eplatform.co.

Include:

  • your ePlatform library name;
  • the name of your Library Management System;
  • the SIP2 server address and port;
  • whether the issue affects one account or every account;
  • whether the same account can sign in to the LMS; and
  • the error message displayed, if any.