Fess API Guide

Introduction

• Target Audience
• Before You Read This Document
• API Usage Prerequisites
• Online Access
• Technical Support Contact
• References to Related Third-Party Websites
• How to Send Comments and Suggestions

API Overview

• APIs Provided by Fess
• Base URL
• Authentication
• HTTP Methods
• Response Format
• Error Handling
• Types of APIs

Search API

• Fetching Search Results
• Searching All Documents
• Error Response

Label API

• Fetching Labels
• Usage Examples
• Error Response

Popular Words API

• Fetching Popular Words List
• Error Response

Suggest API

• Fetching Suggest Words List
• Error Response

Health API

• Fetching Status
• Error Response