Web interface¶

Web API¶

The web API allows other applications (notably Kingfisher Collect) 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.

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

To use Kingfisher Process in a production environment with Kingfisher Collect, see Flask’s documentation on deploying apps.