Rest API Usage

Version 5 introduced a formal, structured REST api to Aspire. This should make it much easier to externally manage and control Aspire, say for instance, from scripts or utilities such as Postman. Whilst Aspire will still allow general components to implement their own servlets and APIs, the Aspire Administration API can be split in to three broad areas of functionality

Configuration and control API

The configuration and control API provides functionality that allows a administrator to perform actions such as adding a seed to crawl, or beginning or stopping a crawl. This API will provide the functionality required by the Aspire User interface and will be extensively used by it. The API will also be used by any external process (or script) that needs to control Aspire

Manager Node API

The manager API provides functionality used with in the connector framework. The manager API is an internal API that is not intended to be used other than by other Aspire processors

Worker Node API

The worker API provides functionality used with in the connector framework. The worker API is an internal API that is not intended to be used other than by other Aspire processors