Open file through API server
First you need to run an API server. There is a simple ARES Kudo can connect to different backends developed by the partner. ARES Kudo connects to the backends to access files, user information and supports additional workflows including commenting and markup.
Graebert provides a sample API server that implements all required REST APIs used by editor application ARES Ku do to open and save files. It is located in installation directory besides Kudo folder in API_server.
Before you setup API server, you need to install Requirement: nodejs (https://nodejs.org/en/download/)
Now you can To run the sample API server:
Open command line and go to Navigate to the sample API server location. On Linux: /opt/graebert-gmbh/Kudo-Server/API_server
Run “sudo npm “npm install” to install server
Run “node bin/www” “npm run start” to run server
The sample API server is now accessible and runs on port 3000. See next section how to open a files with editor.
To open a file with editor you have to pass API server and file to editor url.
Required parameters are:
...
The sample API server provides access to local files on the host of the sample API server. To test the server, access the sample files shipped with with server or any other accessible file:
GET http://localhost:3000/api/files/Construction.dwg/info
...
file - path of the drawing file you want to open
...
access - mode you want to open the file in. Accepted values “edit” for editing and “view” for view mode. If not passed, edit mode is used
So url /api/files/Construction.dwg/diffs
To open a file with editor, pass the API server address and file id to editor.
The URLs to open a drawing should be like:
...
Viewer:
http://localhost:8081/editor?server=http://localhost:3000&file=/home/andrea/Documents/My%20Drawings/testConstruciton.dwg&access=view
NOTE: The file identifier does not have to be an actual filename and can be any arbitrary identifier that is passed from editor back to the backend.