yupengyan/sushi

Documentation for the Springer SUSHI service

The Springer SUSHI service

The Springer SUSHI service enables our customers to download their COUNTER usage statistics for the Springer Link platform. Information on the SUSHI protocol is available from the NISO website, as is the schema and the WSDL.

Our endpoint is located at http://services.springer.com/sushi.

Data can be retrieved by posting a valid SUSHI request like the sample included in this repository:

curl -d @sample_request.xml "http://services.springer.com/sushi" --header "content-type: text/xml"

In order to retrieve data for your organisation you need to know the Springer Business Partner ID of the organisation. This should be supplied as the value for the //CustomerReference/ID element in the request. Your email address should be supplied as the value for //Requestor/Email:

<sus:Requestor>
  <sus:ID></sus:ID>
  <sus:Name></sus:Name>
  <sus:Email>[email protected]</sus:Email>
 </sus:Requestor>
 <sus:CustomerReference>
   <sus:ID>3000093925</sus:ID>
</sus:CustomerReference>

The report required should be requested using the ReportDefinition element:

<sus:ReportDefinition Name="JR1" Release="4">

The following report names are supported:

JR1
JR1 GOA
JR2
JR5
BR2
BR3

The only supported value for Release is 4.

Consortia admins looking to harvest data for their members can download a list of member business partner identifiers via the admin interface. Note that we do not support the combined CR1 report.

SUSHI for BioMed Central and SpringerOpen

To obtain usage statistics for the BioMed central platform and SpringerOpen site you need to post a similar request to the endpoint http://services.springer.com/sushi/bmc.

In this case you need to use your BioMed Central Institutional ID as the value of //CustomerReference/ID and this should be namespaced with the prefix BMC: e.g.

<sus:Requestor>
  <sus:ID></sus:ID>
  <sus:Name></sus:Name>
  <sus:Email>[email protected]</sus:Email>
</sus:Requestor>
<sus:CustomerReference>
  <sus:ID>BMC:201</sus:ID>
</sus:CustomerReference>

For these platforms only the journal reports apply:

JR1
JR1 GOA
JR2
JR5