• en-US
  • pt-PT
www.shelfus.com

ShelfUs API


Want to integrate ShelfUs with your website? You are in the right place!


The ShelfUs API allows you to do about anything has if you were using our website or the mobile application. In order to use this functionalities just send us an e-mail requesting an API Key
Function Description Parameters Response
userArea.fLogin * Makes the autentication need for some of the functions. Replies with the sessionid. email
password
						
<?xml version="1.0" encoding="UTF-8"?>
<root function='userArea.fLogin'>
	<operation status='ok'/>
	<data>
		<customer idcustomer='x' sessionid='xxxx' name='xxxxx' language='xx'/>
	</data>
</root>
						
					
userArea.fLogout Log out of the system
						
<?xml version="1.0" encoding="UTF-8"?>
<root function='userArea.fLogout'>
	<operation status='ok'/>
</root>
						
					
userArea.profile.fView Get the info from the profile of the customer (if no parameter is passed) or friend (if idcustomer is given)
						
<?xml version="1.0" encoding="UTF-8"?>
<root function="userArea.profile.fView">
<operation status="ok"/>
<data>
	<customer idcustomer="1" name="Administrador ShelfUs" email="admin@shelfus.com" image="http://gravatar.com/avatar/111" imagetype="external" nfriends="4" ncircles="5" nitems="41"/>
</data>
</root>
						
					
friends.fList List the friends of the autenticated user
						
<?xml version="1.0" encoding="UTF-8"?>
<root function="friends.fList">
	<operation status="ok"/>
	<data>
		<friend idcustomer="xxx" name="Jxxxx Rxxxx" email="xxx" image=""/>
		<friend idcustomer="xxx" name="Rxxxx Cxxxx" email="xxx" image="//base64 encoded image when imagetype='internal'" imageextension="jpg" imagetype="internal" / >
	</data>
</root>
						
					
library.fList List the library of the the autenticated user colnames: (title) | (image) | (name) | (customername) | (year) | (rating) | (description) |...'
bSearchable_0: 0/1
bSearchable_1: 0/1
bSearchable_...: 0/1
sEcho: 'xx'
iDisplayStart: 'xx'
iDisplayLength: 'xx'
						
<?xml version="1.0" encoding="UTF-8"?>
<root function="library.fList">
	<operation status="ok"/>
	<data>
		<datatable sEcho="xx" iTotalDisplayRecords="xx" iTotalRecords="xx">
			<book title="Os Irmãos Karamazov" image=""/> <book title="Cândido ou o Optimismo" image="http://upload.wikimedia.org/wikipedia/commons/thumb/4/4c/Candide1759.jpg/200px-Candide1759.jpg" imagetype="external"/>
		</datatable>
	</data>
</root>
						
					
library.item.fView Get the details of the specified item iditem
						
<?xml version="1.0" encoding="UTF-8"?>
<root function="library.item.fView">
	<operation status="ok"/>
	<data>
		<movie iditem="xx" idcategory="xx" idcustomer="xxx" title="Harry Potter and the Goblet of Fire" image="http://content9.flixster.com/movie/95/72/15/9572155_det.jpg" barcode="" othercode="0330373" rating="8" genre="" year="2005" support="" location="Room" description="The main..." language="" publisher="" country="" director="" subtitle="" imagetype="external"/>
	</data>
</root>
						
					

Useful Notes

  • The * marked functions are functions that do not need the sessionid token. All others need sessionid passed in the url (ex: ...&sessionid=... );
  • All the functions parameters should be sent in POST;
  • All requests should be like: core.shelfus.com/?apikey=givenApiKey&function=functionName;

Getting Started  |  Mobile  |  Android  |  Developers  |  About  |   |  Shelfus © 2011-2017