Web interface

Web API

The web API allows other applications (notably Kingfisher Scrape) to submit data to this tool to store.

All requests must set an HTTP Authorization request header with an authentication type of ApiKey. For example:

Authorization: ApiKey <key>

To configure the API keys, see Configuration.

API endpoints are documented on SwaggerHub.

Web app

The web app allows you to view metadata about collections and files.

To run the app locally in development mode:

FLASK_APP=ocdskingfisherprocess.web.app FLASK_ENV=development flask run

Then, open <http://127.0.0.1:5000/>