Index

Methods POST /api/signup POST /api/login GET /api/list/files POST /api/files PUT /api/files/:hash GET /api/files/:hash POST /api/archive/:hash POST /api/unarchive/:hash POST /api/files/audit POST /api/files/access DELETE /api/files/access POST /api/user/details Get /api/files/:hash/info Get /api/comments/:hash POST /api/comments/ POST /api/folders POST /api/folders

POST /api/signup

Description

Sign up and login in the platform. If success, returns a Bearer Token.

Input

Headers Content-Type: application/x-www-form-urlencoded Parameters email (text): The user email password (text): The user password name (text): The user name privateKey (text): (Optional) The user private key. by default, it will be randomly generated.

Output

Status 200 token (text): If status is true, the user authorization token email (text): If status is true, the user email Status 400 message (text): The error message

POST /api/login

Description

Authentificate in the platform and returns a Bearer Token.

Input

Headers Content-Type: application/x-www-form-urlencoded Parameters email (text): The user email password (text): The user password

Output

Status 200 token (text): If status is true, the user authorization token email (text): If status is true, the user email Status 400 message (text): The error message

GET /api/list/files

Description

List all yours files.

Input

Headers Authorization: Bearer LOGIN_TOKEN Parameters dir (text): (Optional) The parent directory id. Default is set to root directory. page (integer): (Optional) The page number. Default set to 0 (first page). limit (integer): (Optional) The maximum files per page. Default set to 7. search (text): (Optional) The search string. If not empty it will search for matching file names. Default empty. boolean (archived): (Optional) If true, it will include archived files. Default set to false.

Output

Status 200 items (list): The items list parent (object): The parent folder object or empty if it is the root. pagination (object): The pagination information. Status 400 message (text): The error message

POST /api/files

Description

Uploads multiple files to the system

Input

Headers Authorization: Bearer LOGIN_TOKEN Parameters files ([file]): The files to upload parentFolder (text): (Optional) The parent folder id. By default is the root folder.

Output

Status 200 hashes (text): The list of all encrypted file hashes Status 400 message (text): The error message errors (list): (Optional) If there are multiple errors, these are the errors.

PUT /api/files/:hash

Description

Edits a file

Input

Headers Authorization: Bearer LOGIN_TOKEN Parameters file (file): The edited file hash (query): The old hash file

Output

Status 200 hash (text): The new file hash Status 400 message (text): The error message

GET /api/files/:hash

Description

Downloads a file

Input

Headers Authorization: Bearer LOGIN_TOKEN Parameters hash (query): The encrypted file hash

Output

Status 200 file (file): The decrypted file Status 400 message (text): The error message

POST /api/archive/:hash

Description

Set a file as archived

Input

Headers Authorization: Bearer LOGIN_TOKEN Parameters hash (query): The encrypted file hash

Output

Status 200 status (boolean): The result of archiving file Status 400 message (text): The error message

POST /api/unarchive/:hash

Description

Set a file as unarchived

Input

Headers Authorization: Bearer LOGIN_TOKEN Parameters hash (query): The encrypted file hash

Output

Status 200 status (boolean): The result of archiving file Status 400 message (text): The error message

POST /api/files/audit

Description

Check if a file already exists in the system.

Input

Headers Authorization: Bearer LOGIN_TOKEN Parameters file (file): The file to audit

Output

Status 200 exists (boolean): True if the file exists in the system hash (text): True file hash if exists name (text): The file name if exists Status 400 message (text): The error message

POST /api/files/access

Description

Give acces to the file to a user's specific public key.

Input

Headers Authorization: Bearer LOGIN_TOKEN Content-Type: application/x-www-form-urlencoded Parameters hashes (text): The list of file hashes separated by ; userkey (text): The encrypted file hash permission (integer): The permission type

Output

Status 200 status (boolean): True if the the access is successfully granted Status 400 message (text): The error message errors (list): (Optional) If there are multiple errors, these are the errors.

DELETE /api/files/access

Description

Remove acces to the file to a user's specific address.

Input

Headers Authorization: Bearer LOGIN_TOKEN Content-Type: application/x-www-form-urlencoded Parameters hash (text): The encrypted file hash user (text): The user address

Output

Status 200 status (boolean): True if the the access is successfully granted Status 400 message (text): The error message

POST /api/user/details

Description

Get the user details from address, publicKey or email

Input

Headers Authorization: Bearer LOGIN_TOKEN Content-Type: application/x-www-form-urlencoded Parameters * It must be only one parameter from the list: email (text): The user email address (text): The user address publicKey (text): The user public key

Output

Status 200 address (text): The user address publicKey (text): The user public key email (text): The user email name (text): The user name Status 400 message (text): The error message

Get /api/files/:hash/info

Description

Get the file info by hash

Input

Headers Authorization: Bearer LOGIN_TOKEN Parameters hash (query): The encrypted file hash

Output

Status 200 file (object): The file object Status 400 message (text): The error message

Get /api/comments/:hash

Description

Gets the file comments

Input

Headers Authorization: Bearer LOGIN_TOKEN Parameters hash (query): The encrypted file hash

Output

Status 200 comments (object): The comments object Status 400 message (text): The error message

POST /api/comments/

Description

Create a new comment to a file

Input

Headers Authorization: Bearer LOGIN_TOKEN Content-Type: application/x-www-form-urlencoded Parameters hash (text): The associated encrypted file hash text (text): The comment text

Output

Status 200 status (boolean): The comment save status Status 400 message (text): The error message

POST /api/folders

Description

Creates a folder

Input

Headers Authorization: Bearer LOGIN_TOKEN Content-Type: application/x-www-form-urlencoded Parameters folderName (text): The folder name parentFolder (text): The parent folder ID

Output

Status 200 status (boolean): The creation folder status Status 400 message (text): The error message

POST /api/folders

Description

Change the directory of a files list

Input

Headers Authorization: Bearer LOGIN_TOKEN Content-Type: application/x-www-form-urlencoded Parameters hashes (list): The file hashes list separated by ';' directory (text): The target directory ID

Output

Status 200 status (boolean): The change directory operation status Status 400 message (text): The error message errors (list): (Optional) If there are multiple errors, these are the errors.