Ready to Learn?Ex Libris products all provide open APIs

General Purpose

Rosetta SOAP Web Services provide a large number of APIs which can be called from any external application.

Most SOAP Web Services require a PDS handle. PDS is packaged with the Rosetta SDK. See here for integrating PDS in your application.

Alternatively, obtain a PDS handle over http:

http://[pds_host]:[pds_port]/pds?func=login&bor_id=[username]&bor_verification=[password]&institute=[institution_code]

For example: 

http://rosetta.myorg.edu:8991/pds?func=login&bor_id=admin1&bor_verification=a12345678A&institute=INS00

Backward Compatibility

Rosetta API changes are backwards compatible. However, please note that new fields may be added to a returned complex object. Therefore, your web service client must be able to ignore unknown fields in order to maintain backward compatibility, or you will need to recompile when these kind of modifications are introduced.

Authentication

Most SOAP Web Services require authentication. Rosetta APIs support two authentication methods:

  • Basic Authentication (v. 5.2+): A base64 encoded user, institution code and password, sent as an Authorization HTTP header. Decoded string should be {username}-institutionCode-{institutionCode}:{password}, e.g. vickyholmes-institutionCode-INS00:9uQ29kZS1JT.
Basic Authentication is supported for Rosetta local users only and is the recommended method for authenticating local users.
When using Basic Authentication, you may omit the PDS handle argument or provide a null value (depending on your implementation).
  • PDS handle: PDS is packaged with the Rosetta SDK. See here for integrating PDS in your application. 
Alternatively, you may obtain a PDS handle over http:
https://[pds_host]:[pds_port]/pds?func=login&bor_id=[username]&bor_verification=[password]&institute=[institution_code]
For example: 
https://rosetta.myorg.edu/pds?func=login&bor_id=admin1&bor_verification=a12345678A&institute=INS00
 

Users should note the required roles for each type of web service.

 

Access Restriction

Access to Rosetta web services can be restricted by IP range (IPv4 only). This is managed in the IP WebService Restriction mapping table.

Web Service NameCode in Mapping Table
Collection Related Web ServicesCollectionWebServices
Data Management Web ServicesDataManagerServicesWS
Delivery Web ServicesDeliveryAccessWS
Deposit Related Web ServicesDepositWebServices
IE Update Web ServicesIEWebServices
Producer Related Web ServicesProducerWebServices
SIP Processing Related Web ServicesSipWebServices
SRUSRUServlet
Collection TreeCollectionTreeServlet

Other rows in this table refer to internal web services for communication between Rosetta servers and should not be edited.