Skip to main content

Methods

Accounts​

ActionDescription
getAccountInfosGet information on your account
fetchAccountSubscriptionsFetch the folders of your account
fetchAccountBooksFetch the publications of your account
fetchAccountSubscribersFetch the subscribers of your account

Folders​

ActionDescription
getSubscriptionInfosGet information on a folder
fetchSubscriptionBooksFetch the publications of a folder
fetchSubscriptionSubscribersFetch the subscribers of a folder

Publications​

ActionDescription
getBookInfosGet information on a publication
activateBookActivate a publication
deactivateBookDeactivate a publication
updateBookUpdate a publication's properties
deleteBookPermanently delete a publication
fetchBookTocsFetch a publication's table of contents
fetchBookCommentsFetch the comments of a publication
renewBookPrivateUrlChange the private URL of a private publication

Publishing​

ActionDescription
publishPublish a document
publishFromUrlPublish a document from a URL
publishFromTextPublish a document from plain text
reviseUpload a new version of an existing publication
reviseFromUrlUpload a new version of an existing publication from a URL
reviseFromTextUpload a new version of an existing publication from plain text

Subscribers​

ActionDescription
getSubscriberInfosGet information on a subscriber
activateSubscriberActivate a subscriber
deactivateSubscriberDeactivate a subscriber
addSubscriberAdd a new subscriber to a folder
updateSubscriberUpdate a subscriber's properties
deleteSubscriberPermanently delete a subscriber
fetchSubscriberBooksFetch a subscriber's publications
authSubscriberSessionAuthenticate a subscriber login/password and create a subscriber session
checkSubscriberSessionValidate a subscriber session
deleteSubscriberSessionTerminate a subscriber session

Subscribers DRMs​

ActionDescription
fetchSubscriberDRMSinglesFetch the Single DRMs of a subscriber
fetchSubscriberDRMPeriodsFetch the Period DRMs of a subscriber
fetchSubscriberDRMSeriesFetch the Series DRMs of a subscriber
addSubscriberDRMSingleAdd a new Single DRM to a subscriber
addSubscriberDRMPeriodAdd a new Period DRM to a subscriber
addSubscriberDRMSerieAdd a new Series DRM to a subscriber
updateSubscriberDRMPeriodUpdate an existing Period DRM of a subscriber
updateSubscriberDRMSerieUpdate an existing Series DRM of a subscriber
deleteSubscriberDRMSinglePermanently delete a Single DRM of a subscriber
deleteSubscriberDRMPeriodPermanently delete a Period DRM of a subscriber
deleteSubscriberDRMSeriePermanently delete a Series DRM of a subscriber
clearSubscriberDRMsPermanently delete all DRMs of a subscriber