Archv API

Archv has a REST API implemented using Eclipse Jetty. The Jetty servlet is meant to be embedded within the Archv application. When the servlet is started, the four programs of archv can be interfaced with using HTTP GET and POST requests.

If you want to set up the servlet on your system, you can clone the repository here: /avkoehl/archv-jetty.

What follows are the descriptions for interfacing with Archv through localhost served on port 8888. Each program can be accessed through a base url. The parameters are passed to the program following a specific format through the url. The structure is something like this:

http://localhost:8888/show/show?param1=value&param2=value...

Upon success, a json message will be recieved from the url.

{"file": "path/to/outputfile"}


Show Keypoints

The base url for showKeypoints:

http://localhost:8888/show/show?

The parameters that can be passed to showKeypoints:

-i = path/to/inputimage
-o = path/to/output.jpg
-p = path/to/paramfile

The full url:

http://localhost:8888/show/show?-i=/path/to/image&-o=/path/to/output.jpg&-p=/path/param/


Process Images

The base url for processImages:

http://localhost:8888/process/process?

The parameters that can be passed to processImages:

-i = path/to/imageset/
-o = path/to/keypointdirectory/
-p = path/to/paramfile

The full url:

http://localhost:8888/process/process?-i=/path/to/image&-o=/path/to/keypointdir/&-p=/path/param/


Scan Database

The base url for scanDatabase:

http://localhost:8888/scan/scan?

The parameters that can be passed to scanDatabase::

-i = path/to/inputimage
-d = path/to/imageset
-k = path/to/keypointdirectory
-o = path/to/output.json
-p = path/to/paramfile

The full url:

http://localhost:8888/scan/scan?-i=/path/to/image&-d=/path/to/imageset/&-k=/path/to/keypointdir/&-o=/path/to/output.json&-p=/path/param/


Draw Matches

The base url for drawMatches:

http://localhost:8888/draw/draw?

The parameters that can be passed to drawMatches::

-i1 = path/to/image1
-i2 = path/to/image2
-o = path/to/output.jpg
-p = path/to/paramfile

The full url:

http://localhost:8888/draw/draw?-i1=/path/to/image&-i2=/path/to/image2&-o=/path/to/output.json&-p=/path/param/