API
Contents |
Preface
PowerFolder Server/Cloud offers an API to expose functions to third party applications, such as creating new folders, new user accounts or adding/removing users to/from a folder.
The API is currently in BETA stadium.
Technical
The API is realized as RESTful web service running at a URI of PowerFolder Server, e.g. http://myserver.com:8080/api/folders. A URI is called a service. The API accepts POST and GET HTTP requests. Parameters have to be URL encoded.
Each service accepts one or more parameter and returns its result in JSON format. Each service offers several methods or actions that can be executed. In case an error occurs a HTTP status code different from 200 (OK) is sent back.
Example:
http://myserver.com:8080/api/folders?action=create&name=MyFiles
- Service: folders
- Action: create
- Parameter(s): name=MyFiles
Authorization / Security
Calls to the API always require an authorized caller. This is done by basic access authorization which must be added to each call. Depending on the service and action it's required to authenticate with a regular user or admin (always works).
