Development API Overview
BabelBird develops APIs to connect the authentication, file, sharing, organization, messaging and login capabilities of enterprise network disks to third-party business systems. The left column is grouped by interface function, and the callable endpoints are listed directly in the group.
Call overview
- The enterprise administrator creates a developer account in the private cloud enterprise management background and obtains
client_id,client_secretand JWT related keys. - In the OAuth callback method, use
/api/authorize.doto obtain the authorization code, and then use/api/token.doto obtainaccess_token. - JWT login-free method uses
/api/authorizeByJWT.door/account/tokenLogin.do, and private deployment needs to enable the corresponding configuration. - File access API requests need to carry
Authorization: Bearer <access_token>in the HTTP Header. - POST, PUT, DELETE requests usually use
Content-Type: application/json.
API Grouping
| Grouping | Main purpose | Typical entrance |
|---|---|---|
| Authentication API | Developer account, OAuth callback, JWT login-free, Token acquisition and refresh | Get token |
| File API | File list, file information, upload and download, version, move copy, recycle bin, material library classification | Get file list |
| Sharing API | Sharing link, sharing permissions, participants, attention reminders | Get file sharing url |
| Enterprise API | Enterprise information, departments, members, enterprise logs | Get current enterprise information |
| Message and login API | Announcements, department discussions, JWT token login, common status codes | JWT token login |
Single interface page
Each API entry has an independent page, allowing developers to check paths, methods, parameters and return information by interface.
- GET authentication interface one (login callback method):
/api/authorize.do - GET authentication interface two (login-free JWT token method):
/api/authorizeByJWT.do - POST Get token:
/api/token.do - POST refresh token:
/api/refreshToken.do - GET Get file list:
/nd/api/file/list_dir - GET Get file information:
/nd/api/file/fileinfo - POST create folder:
/nd/api/file/create_folder - GET preupload file:
/api/file/preUploadFile.do - GET Get download file address:
/api/file/getFileDownloadUrl.do - GET Get download multi-file address:
/api/file/downloadMultiFiles.do - GET Get download file thumbnail address:
/api/file/downloadThumbnail.do - POST modify file information:
/nd/api/file/update_file - POST modify file name:
/nd/api/file/rename - POST delete file (to recycle bin):
/nd/api/file/remove_file - POST remove file (from trash):
/nd/api/file/remove_from_trash - POST Empty Trash:
/nd/api/file/empty_trash - POST restore file (from recycle bin):
/nd/api/file/restore_file - GET Get all version information of the file:
/nd/api/file/versions - POST setting file current version:
/nd/api/file/version - POST move file:
/nd/api/file/move - POST copy file:
/nd/api/file/copy - POST copy file progress:
/nd/api/file/copy_progress - GET file log:
/nd/api/file/file_logs - POST sets whether the user has permission to access the material library:
/nd/api/file/set_user_access_material_library - POST Create Material Library Classification:
/nd/api/file/create_material_class - POST create sub-material library:
/nd/api/file/create_material_folder - GET Get the share url of the file:
/nd/api/share/shareurl - GET Get the shared permission list:
/nd/api/share/share_roles - GET Get the sharing role that the user has permission to set for a single file:
/nd/api/share/share_role_forfile - POST Create Link Share:
/nd/api/share/open_link_share - POST close link sharing:
/nd/api/share/close_link_share - POST set link sharing password:
/nd/api/share/set_share_password - POST invite people to participate in sharing:
/nd/api/share/invite_share - GET Get all sharing participants:
/nd/api/share/share_participants - POST set permission roles of sharing participants:
/nd/api/share/set_participant_role - POST delete sharing participant:
/nd/api/file/remove_share_participant - POST reminder:
/nd/api/file/focus_file - POST remove someone's attention:
/nd/api/file/unfocus_file - GET Get the list of users focusing on the file:
/nd/api/file/user_focusfile - GET Get the list of users who can focus on the file and mark the users who have focused on the file:
/nd/api/file/user_can_focusfile - GET Get current enterprise information:
/nd/api/enterprise/current - GET Get information about all departments of the enterprise:
/nd/api/enterprise/departments - POST Create Enterprise Department:
/nd/api/enterprise/create_department - GET Get department role list:
/nd/api/enterprise/dep_role - POST add department personnel:
/nd/api/enterprise/add_dep_mem - POST delete department personnel:
/nd/api/enterprise/remove_dep_mem - GET to obtain information about your own department:
/nd/api/enterprise/mydeparments - GET Get Department Members:
/nd/api/enterprise/departmentmembers - POST add enterprise members:
/nd/api/enterprise/add_ent_mem - POST update member information:
/api/updateUserInfo.do - GET Get enterprise member information:
/api/getEnterpriseMember.do - POST Get all members of the enterprise:
/nd/api/enterprise/enterprise_members - POST Get Enterprise Logs:
/nd/api/enterprise/enterprise_logs - POST Release Announcement:
/nd/api/enterprise/broadcast - GET Get published announcements:
/nd/api/enterprise/broadcast - POST Send Department Discussion:
/nd/api/file/send_dep_discussion - POST Get department discussion:
/nd/api/file/dep_discussion - GET Get Enterprise Logs:
/nd/api/enterprise/enterprise_logs - GET JWT token login:
/account/tokenLogin.do