11 SUSHI for Automated Report Harvesting
Content providers MUST support automatic harvesting of reports via the SUSHI protocol as described in the NISO SUSHI Protocol (ANSI/NISO Z39.93-2014: Standardized Usage Statistics Harvesting Initiative (SUSHI) Protocol, 2014) and the Research Data SUSHI API Specification (Research Data SUSHI API Specification, 2018).
11.1 Research Data SUSHI API Paths to Support
The following paths (methods) MUST be supported:
Table 11.1 (below): Research Data SUSHI API Paths
Path |
Description |
|---|---|
GET /status |
Returns the current status of the Research Data SUSHI API service. This path returns a message that includes the operating status of the API, the URL to the service’s entry in the Register of Compliant Content Providers, and an array of service alerts (if any). |
GET /reports |
Returns a list of reports supported by the Research Data SUSHI API service. The response includes an array of reports, including the report identifier, the release number, the report name, a description, a list of supported report filters, and a list of supported report attributes. |
GET /reports/{ReportID} |
Each supported report has its own path, e.g. GET /reports/DSR for dataset requests. |
11.2 Authentication and Security for the Research Data SUSHI API
The Research Data SUSHI API SHOULD be implemented using TLS (HTTPS). The Research Data SUSHI API MAY be secured using an API key or username/password assigned to the organization harvesting the usage.
11.3 Report Filters and Report Attributes
The Research Data SUSHI API Specification allows report responses to be customized to the caller’s needs using report filters and report attributes. These filters and attributes are implicit for Standard Views. Filters and attributes are explicitly included as parameters on the Research Data SUSHI API request for Master Reports. Refer to (Research Data SUSHI API Specification, 2018) for the list of filters and attributes supported by the various reports.
11.4 Research Data SUSHI API Errors and Exceptions
Implementations of the Research Data SUSHI API MUST comply with the warnings, exceptions and errors described in the Research Data SUSHI API Specification. See Appendix B.
11.5 SUSHI Service Limits
The content provider MUST NOT place limits on the SUSHI service (such as requests per day or amount of data transferred) that would prevent users from retrieving reports.