Implementing the Symplectic API
October 12, 2012 Leave a comment
We’ve made real progress implementing the Symplectic API which I hope will help motivate academic staff to update and maintain their Symplectic profile and, who knows, perhaps even encourage them to upload full-text to the repository! Kudos to web-developer Mike Taylor who has done all the clever stuff (though this summary reflects my understanding so may contain errors!)
As can be seen in the screen-shot below, Mike has been able to submit a query to the API (using Leeds Met username as a parameter) and differentially parse the resulting XML by publication type including, where available, links to DOI and full-text in the repository (currently labelled as Public URL). Symplectic also has the option to “favourite” records which is flagged in the XML and which we’ve use to identify “Selected publications” in order to give academics greater control over their profile (there is also a “make invisible” option to prevent specific records being exposed from the API.)
The next step will be to liaise with the corporate web-team to explore how the feed can be embedded in the institutional CMS. We’ve already picked a few brains and it shouldn’t be too difficult though there are still one or two technical issues including how best to submit a query; we wouldn’t want to use username as that would be a privacy issue and the preference would be email address though this will require a layer of translation from email address (which isn’t searchable)to either Leeds Metropolitan username or Symplectic internal user id. In addition, the API isn’t designed to be hammered dynamically so results need to be cached so there are questions how best to refresh that cache to reflect changes that academics may wish to make to their profile.