Following is the design philosophy applied to 689Cloud API.
- API protocol must be HTTPS
- API request parameters must be passed using query string for APIs that require GET
- API request parameters must be “application/x-www-form-urlencoded” for APIs that require POST
- API response body format must be JSON except when binary data returned
- All API response object has following properties
Server URL: https://www.689cloud.com/api/{API_NAME}
For example Login API: https://www.689cloud.com/api/user/login
- Authentication
- Create Project
- Get list of projects
- Get files/folders in project
- Upload file into project
- Encode file & register lincese for all member in project
- Create a folder in project
- Get file License setting
- Update file License setting
- Download File
- File & Folder sharing
| Status | Code | Description |
|---|---|---|
| ERR_INVALID_DATA | 100 | Input data is not valid |
| ERR_USER_NOT_EXIST | 110 | User does not exist |
| ERR_USER_NOT_VALID | 111 | User name or password is not correct |
| ERR_USER_ROLE_NOT_VALID | 112 | You do not have permission to access this page |
| OK | 200 | null |
| ERR_ENCODE | 300 | Error encoding file |
| ERR_UPLOAD_FILE | 301 | Upload file error |
| INVALID_PARAMETER | 400 | Invalid parameter |
| INVALID_ACCESS_TOKEN | 401 | Invalid access token |
| ERR_EXPIRE_TOKEN | 401 | The token is expired |
| ERR_TOKEN_NOT_EXIST | 401 | Token does not exist |
| ERR_INVALID_FOLDER | 401 | New folder is child of moved folder |
| INVALID_ROLE_USER | (403 | User do not have permission |
| MISSING_PARAMETER | 404 | Parameter missing |
| PROJECT_NOT_FOUND | 404 | Project not found |
| FOLDER_NOT_FOUND | 404 | Folder not found |
| FILE_NOT_FOUND | 404 | File not found |
| USER_NOT_FOUND | 404 | User not found |
| USER_NOT_FOUND_IN_PROJECT | 404 | User not found in the project |
| LINK_NOT_FOUND | 404 | Link not found |
| COMMENT_NOT_FOUND_OF_USER | 404 | Comment not found |
| LINK_EXPIRED | 410 | link is expired |
| WRONG_ACTIVATION_CODE | 411 | activation code is not correct |
| USER_ACTIVE | 412 | User has been active |
| INVALID_LIMIT_USER | 413 | Out of number of members in team |
| CREATE_HISTORY_FAILED | 417 | Create history failed |
| CREATE_SESSION_FAILED | 417 | Create session failed |
| INVALID_QUERY_SQL | 500 | Invalid query SQL |
| SYSTEM_EXCEPTION | 500 | System error |
| ERR_INVALID_EMAIL | 501 | Invalid email |
| ERR_INVALID_FIRSTNAME | 502 | First Name contains speacial character |
| ERR_INVALID_LASTNAME | 503 | Last Name contains speacial character |
| ERR_INVALID_PASSWORD | 504 | Password is too short |
| ERR_INVALID_CONFIRMPASSWORD | 505 | Your confirm password is incorrect |
| ERR_INVALID_ROLEID | 506 | You do not have the permission to do this action |
| ERR_INVALID_EMAIL_EXIST | 507 | This email is already exist |
| ERR_INVALID_WRONGPASSWORD | 508 | Wrong password |
| ERR_INVALID_CANNOT_REMOVE_YOURSELFT | 509 | Cannot change yourself status from active to remove |
| ERR_ROLEID_NOT_EXIST | 510 | This role is not exist |
| ERR_INVALID_MIDDLENAME | 511 | Middle Name contains speacial character |
| ERR_LIMITED_USER | 512 | Limited Create User |
| ERR_TEAM_NOT_EXIST | 513 | This Team does not exist |
| ERR_TEAM_EXIST | 514 | This Team is existent |
For more infomation about 689Cloud please reference at https://www.689cloud.com
If any question regarding to APIs usage and customization support, please get in touch with us at https://689cloud.com/contact-us