APIs
General Purpose
Rosetta SOAP Web Services provide a large number of APIs which can be called from any external application.
List of Web Services
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.
- 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 Name | Code in Mapping Table |
|---|---|
| Collection Related Web Services | CollectionWebServices |
| Data Management Web Services | DataManagerServicesWS |
| Delivery Web Services | DeliveryAccessWS |
| Deposit Related Web Services | DepositWebServices |
| IE Update Web Services | IEWebServices |
| Producer Related Web Services | ProducerWebServices |
| SIP Processing Related Web Services | SipWebServices |
| SRU | SRUServlet |
| Collection Tree | CollectionTreeServlet |
Other rows in this table refer to internal web services for communication between Rosetta servers and should not be edited.