Rest API

Using the Rest API

To run the rest api you will start the restfulHarvest binary/script. You may get an initial exception but run it again and it will work. If you want to see what cli switches there are just do restfulHarvest -h by default the api runs on localhost and on port 5000.

To see the documentation on the api when you run the rest api binary if you go to /docs endpoint you will be greeted with the information.

Example API script

To interact with the rest api please see this example script

Development

To add new features to the api the file that needs modifying is api.py depending on what you are adding you may also need to do changes main.py and other locations as well. This should be all you need for the majority of changes that you may want to add to the rest api