This is a cache of https://fess.codelibs.org/15.3/api/intro.html. It is a snapshot of the page at 2025-11-07T00:14:16.523+0000.
Introduction

Menu

Introduction

Target Audience

This document is intended for developers who will be using Fess API features. The following knowledge is assumed:

  • Basic concepts of REST APIs

  • JSON data format

  • Basic knowledge of HTTP protocol

Before You Read This Document

This document demonstrates how to use the API in Fess 15.3.

API Usage Prerequisites

Before using the Fess API, the following setup is required:

  • Fess 15.3 or later must be installed and running properly

  • Enable required settings for each API through the administration screen (refer to each API documentation)

  • API endpoints must be accessible via network

Online Access

For downloads, professional services, support, and other developer information, please visit:

Technical Support Contact

If you have technical questions about this product that are not resolved in this documentation, please visit:

Commercial Support

If you require commercial support for this product, including technical assistance and maintenance, please contact N2SM, Inc..

How to Send Comments and Suggestions

The Fess project is committed to improving this documentation and welcomes comments and suggestions from readers.