You can access the CORE index engines using a RESTful Web API. This API allows to search and retrieve document summaries and document full text, supports hit highlighting and all functionality needed for Smart Filters.
The API is implemented as an application in the default workspace of CORE Administration.
The API is autostarted, as it must be running to allow requests.
To access the API, specifications and examples:
- Open CORE Administration.
- In the Default workspace, look for searchWebApi.
- Click the link on the Details tab.
This opens the API application start page with links to relevant information:
- api-docs
- Link to the API specification as derived from the implementation.
- dod
- Overview of the API, including example code.
- examples
- Examples for common use cases.
- projects
- Links to the top-most API endpoint
- searchWebApi.json
- Link to the original API specification file.
- swagger_ui
- Offers detailed information and example code for the functions you need, both for a curl request and for a request URL.
- Click swagger_ui and then search to get a list of available operations.
- To get an example response, click Try it out! below the response messages for a request type.
- license
- List of licenses and libraries used.
Access via SSO
The RESTful Web API can optionally be run in trusted mode (requiring a customer-specific Tomcat filter for authentication) in order to implement SSO access if needed.
For details, ask Recommind Support.