Home Contact Us Site Map

Home > Developers > API Developer's Guide: URL & Response Name Conventions

URL Format

Examples:

http://api.sharedbook.com/v0.6/auth/login

http://api.sharedbook.com/v0.6/bms/addComment

Generalized:

http://domain/api-version/service/method?[parameters]

Responses

Service Method Response OK HTTP Method
auth login <auth.login status="ok" /> POST
  getSessionToken <auth.getSessionToken status="ok">
<sessionToken>[TOKEN]</sessionToken>
</auth.getSessionToken> 		GET
bmscreate init <bmscreate.init status="ok">
<bms id=[BMS_ID] />
</bmscreate.init> 		POST
  publish <bmscreate.publish status="ok" /> POST
bms addComment <bms.addComment status="ok">
<comment id=[COMMENT_ID] />
</bms.addComment> 		POST
  addPhoto <bms.addPhoto status="ok">
<photo id=[PHOTO_ID] />
</bms.addPhoto> 		POST
  setFrontCoverPhoto <bms.setFrontCoverPhoto status="ok">
<photo id=[PHOTO_ID] />
</bms.setFrontCoverPhoto> 		POST
  setBackCoverPhoto <bms.setBackCoverPhoto status="ok">
<photo id=[PHOTO_ID] />
</bms.setBackCoverPhoto> 		POST
  publish <bms.publish status="ok" /> POST
bookcreate init <bookcreate.init status="ok" /> POST
  setDedication <bookcreate.setDedication status="ok" /> POST
  publish <bookcreate.publish status="ok">
<book id=[BOOK_ID] />
</bookcreate.publish> 		POST
book preview <book.preview status="ok"> <url>[BOOK_URL]</url> </book.preview> GET

Error Response

<[SERVICE_NAME].[METHOD_NAME] status="fail">
<error code="[error-code]" msg="[error-message]" />

</[SERVICE_NAME].[METHOD_NAME]>

Example

<bms.addComment status="fail">
<error code="110" msg="Comment too long" />

</bms.addComment>
SharedBook