Skip to content

File Upload API Documentation

Raphael Panic edited this page Jan 14, 2019 · 1 revision

API endpoints

The File upload API is designed to be minimalistic and easy to use.
Therefore there are only 3 endpoints

  • listFiles: Lists all files related to a given key
  • uploadFile: Uploads one or multiple files
  • fileData: retrieves a file

listfiles

POST: kshare.me/listFiles

Header Parameter:

  • key: Specifies the key to which the file was saved.
    Note: The key has be specified int he HTTP Header!

Sample Result:

[{
    "name":"test.txt",
    "networkPath":"/filedata/testkey_test.txt"
}]

uploadFile

POST: kshare.me/uploadFile

Parameters:

  • key (header): Specifies the key to which the file should be saved.
  • file (body): The data of the file being uploaded

Result:
ok: If the upload was successful
failed: There were problems or your request was wrong

getFile

POST: kshare.me/getfile

Parameters:

  • key (header): Specifies the key to which the file was saved.
  • filename (header): The name of the file saved

Result:
A data stream of the files data

Clone this wiki locally