SUNScholar/API

Back to Developers

Introduction

A web API was introduced with Dspace 4.X, however it was a read-only API. A full read-write RESTful API was released with DSpace 5.X.

See: https://scholar.sun.ac.za/rest

Documentation

• https://wiki.duraspace.org/display/DSPACE/REST+API
• https://github.com/DSpace/DSpace/tree/master/dspace-rest
• https://github.com/DSpace/DSpace/pull/323
• https://wiki.duraspace.org/display/DSPACE/DSpace+Futures+-+REST+API
• https://wiki.duraspace.org/display/DSPACE/Review+of+Existing+Dspace+REST+API+Frameworks
• https://jira.duraspace.org/browse/DS-2045
• http://demo.dspace.org/javadocs/5/apidocs

Example Code

• https://github.com/DSpace-Labs/dspace-rest-requests
• https://github.com/BrunoNZ/dspace-rest-requests
• https://github.com/peterdietz/dspace-rest-rails
• https://github.com/peterdietz/dspace-rest-play

Example Websites

• http://embryo.asu.edu
• http://cursosabertos.c3sl.ufpr.br
• http://dspace-rest-client-play.herokuapp.com
• http://dspace-rails.herokuapp.com/communities

Tests

Please Note

• All the requests use secure connections via https
• To configure secure connections for your repository, click here.

Type the following in a terminal:

curl https://scholar.sun.ac.za/rest/

curl https://scholar.sun.ac.za/rest/test

curl -s -H "Accept: application/xml" https://scholar.sun.ac.za/rest/communities | xmllint --format -

curl -s -H "Accept: application/xml" https://scholar.sun.ac.za/rest/bitstreams | xmllint --format -

Companion Software

• http://postgrest.com
• http://zealdocs.org
• http://sourceforge.net/projects/soapui

Technology

• http://101.apievangelist.com
• https://dzone.com/refcardz/rest-foundations-restful
• http://www.drdobbs.com/architecture-and-design/restful-web-services-a-tutorial/240169069

Research

• http://apievangelist.com
• http://apieconomist.com
• http://apicodex.3scale.net

Alternatives

• https://jspace.atlassian.net/wiki/display/DSPACEAPI/API+Documentation

History

• http://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven
• http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm
• http://roy.gbiv.com

References

• https://wiki.duraspace.org/display/DSPACE/DSpace+Service+based+api
• https://wiki.duraspace.org/display/DSDOC5x/REST+API
• https://wiki.duraspace.org/display/DSDOC4x/REST+API
• http://libguides.mit.edu/apis
• https://dzone.com/refcardz/rest-foundations-restful
• https://en.wikipedia.org/wiki/Representational_state_transfer
• https://en.wikipedia.org/wiki/List_of_Ajax_frameworks