General Purpose

Rosetta SOAP Web Services provide a large number of APIs which can be called from any external application. Rosetta has started an ongoing development to release a full suite of REST APIs, providing parallel services to those currently provided as SOAP services.


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

  • Basic Authentication: 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.
Do not include your consortium code (typically ‘CRS00’) in your institution code.
Basic Authentication can also be used for creating direct delivery URLs to objects that require an authenticated user.
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 in the API request 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:


For example:

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. Changes to this table require a server restart.

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
Collection TreeCollectionTreeServlet

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