API

With version 4, Scholarsphere now has a fully functional API. Currently its features are limited to only support migration of content from version 3, but with future releases, these features will be updated and enhanced.

API Considerations

In order to migrate content, certain features would need to be enabled in the API that would not be a part of typical operations by standard users. These features would overriding the depositor's name and setting creation dates that are different than the default "now" time.

We could make these features available in the API but possibly restrict them to admin users only.

API discussion outcomes for Metadata Database (MDDB aka Unicorn)

Based on discussions to get data from MDDB and transfer data back to MDDB today (12/4). We would like to have a form on MDDB that allows PSU researchers to upload a document from their website with additional metadata to ScholarSphere. ScholarSphere would then store that data and send back a URL for where that content will be stored openly accessible. This is a use case for single file and metadata uploads and how that would be handled by ScholarSphere and return a URL.

Current API Endpoints

The following is "unofficial" documentation of the API, which is not intended for public use.

Setting a Featured Resource

with curl:

curl --location --request POST 'https://scholarsphere.psu.edu/api/v1/featured_resources' \
     --header "X-API-KEY: $YOURAPIKEY" \
     --form "uuid=$UI"'