API Server: Connecting ARES Kudo to a data backend

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 ARES Kudo to open and save files. You can download this package, extract it at API server location of your choice and run it as described below.

Requirement: nodejs (https://nodejs.org/en/download/)

To run the sample API server:

1. Navigate to the sample API server location. Open the server subfolder

2. Run “npm install” to install server

3. Run “npm install -g swagger” to install swagger tool globally

4. Run “swagger project start” to run server

The sample API server is now accessible and runs on port 3000. 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 inside the files subfolder with with server or any other accessible file:

GET http://localhost:3000/api/files/Construction.dwg/info

GET http://localhost:3000/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 depend on which port and path you selected during server install:

Editor:

e.g. for port 8081 and deploy path /editor
http://localhost:8081/editor?server=http://localhost:3000&file=Construction.dwg

or for port 80 and deploy path /
http://localhost/?server=http://localhost:3000&file=Construction.dwg

Viewer:

http://localhost:8081/editor?server=http://localhost:3000&file=Construction.dwg&access=view

http://localhost/?server=http://localhost:3000&file=Construction.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.