👋 Welcome to the Search Ready API v1

Search Ready is an application for searching the content of your website or e-shop. SR currently uses a so-called Single Tenant architecture, where each customer uses their own instance of the application.

For these reasons, before starting any work with our API, it is necessary to contact our support team at devel@searchready.cz and arrange the launch of a new SR instance.

Storing Data in the Search Ready Application

Once you, as an SR client, have your own SR instance available, you can start filling it with data. The easiest and fastest way is to create new indexes through the SR web admin interface. This method requires preparing data in the structure specified in the XML Feeds section. The SR application itself will take care of regular data updates. Updates occur by default once a day.

Another possible way is to insert data through our Backend API. This method gives you greater flexibility and the ability to update data in real-time. Changes on the client's backend are immediately reflected in the SR data.

  • BACKEND API provides direct access to our backend and data manipulation.
  • XML Feeds is used for regular data import into our backend.

Searching Data

The SR application also includes a frontend JavaScript application called SERP (Search Engine Result Page). This SERP handles communication with the SR backend and displays search results. If you decide to use your own frontend interface to display the results, our SERP API is available to you.

  • SERP API is used for communication between the frontend application called SERP and the Search Ready backend.

Built with ❤️ by Search Ready team.

Search Ready
Sign in
powered by Stoplight