Versions Compared

Key

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

...

The certificate needed to communicate with Biblionix's SIP2 service is a private certificate created in communication with Biblionix. It is not a public certificate like those obtained for a fee through a third-party registrar like GoDaddy or Network Solutions. Therefore, there is no fee for the certificate, and the process is very easy. You will create a certificate signing request and send its file to Biblionix. The staff will engage with you by email to make sure any questions you have are answered and that your Circulation Manager is able to connect appropriately. Here is the process.

Step 1. Create a certificate signing request (csr)

Using a client utility such as OpenSSL, issue a command with some custom parameters associated with your organization. The parameters identify your organization's physical location (potentially a main office–this is up to you). I'll use my physical Dallas, Texas location as an example. You also need a service identifier that is unique for to your SimplyE serviceorganization. That identifier will go in the CN field. We'll use <your_org> as a placeholder for your organization's name, or a short form of it, with a '-SIP' suffix. For this certificate, the content of the identifier is not super important, but it should be unique, so using a tag identifying your organization name is a good bet. Again, this is a private certificate between your organization and Biblionix, so no one else will see any of these values.

Code Block
languagebash
openssl req -new -newkey rsa:2048 -nodes -out Biblionix-<your_org>.csr -keyout Biblionix-<your_org>.key -subj "/C=US/ST=Texas/L=Dallas/O=<your_org>/CN=SimplyE-<your_org>org>SIP"

Step 2. Send the certificate signing request to Biblionix

The command above will create two files: a certificate signing request file (Biblionix-<your_org>.csr), and a private key file (Biblionix-<your_org>.key). Submit only the resulting certificate request file by email to Biblionix so they can create the signed certificate. Do not send the private key file. Keep the private key in a secure location on your own servers pending receipt of the signed certificate file from Biblionix. Address Send the request, and any questions about the SIP service configuration, to sip@biblionix.com. In the email, you can also indicate how you want your organization's connection to the email sip@biblionix.comappear in the Apollo SIP Connectivity settings area (see Have library enable SimplyE service access in Apollo below). In the example below, the connection is listed with a service name. It could also be listed as your organization name or something similar, as well. The choice is up to you.

Once Biblionix has created the signed certificate file (.crt extension), they will return it to you (.crt extension) by email. You will use the content of this certificate file, along with the content of the key file below created in Step 1, when configuring a library patron authentication integration (shown below).

Obtain Library-Specific Data

...

Host/domain name: The library's domain name for its Biblionix SIP2 service is very similar to its base Apollo website domain. The Apollo website domain has the following form: <city<library_name>.biblionix.com. The SIP2 domain/hostname will be: <city<library_name>-sip.biblionix.com.

The <city<library_name> tag is actually used as an the Apollo account/login name. It can be an alternate form of the city name, or may be a form of the actual library is usually a keyword in the library name, most commonly the city name. If a library uses its own domain name to front the Apollo catalog, staff won't see the biblionix.com domain until they log in to their Apollo staff page. On their Staff page, the library may not know what its the account name will show up in the URL bar. If for any reason the library has difficulty determining the Apollo account name is. In that case, send a message to sip@biblionix.com and request the library's SIP2 service host name.

Port number: All certificate-based connections use the same port number: 9500.
SIP Login user name: the Apollo account name, <city<library_name>
SIP Login password: when using certificate access, no password is required for login; however, if you wish to pass one, it does not cause an error or prevent login success.

...

This data must be obtained from the library itself. In our experience, we've sometimes received real actual test user credentials; however, sometimes you'll receive real user credentials for of a library staff member. If you receive test user credentials, double-check with library staff to be certain the user is configured in the ILS. Be aware that Biblionix has worked works with really small libraries with , some of which employ very simple barcode numbering. Therefore, it is not unusual to receive barcode numbers that are simple four- or five-digit numbers.

Test user barcode: 98765 (whatever provided by the library)
Test user password: 972-555-1212 (whatever provided by the library)


NOTE: When configuring multiple Apollo libraries

If your organization is configuring many Apollo libraries at once, for example an entire state with a large Apollo presence, Biblionix can work with you to streamline the process of gathering data for the libraries (other than barcodes). Mention your plans to them when you email them.

Have library enable SimplyE service access in Apollo

...

  1. Log into the Settings area (named Setup or Settings) of their Apollo catalog
  2. Click the SIP Connectivity tab
  3. Check the SimplyE correct service checkbox (shown below as "E-Read Texas" for an Amigos implementation)a Texas implementation). The organizational phrase you discuss with Biblionix staff above will be the item that appears here for your implementation.

The setting is saved as soon as the library sets it.

...