REST API for Relevanssi

Description

This plugin provides simple REST API for the popular search WordPress search engine – Relevanssi.

As far as this plugin provides API for Relevanssi plugin, it should be installed.

Key features

  • Search through the posts of certain type. By default all types.
  • Results pagination and optional.
  • Sets X-WP-Total header with total number of records, same way as default search api does.
  • Sets X-WP-TotalPages header with total number of pages, same way as default search api does.

Brief usage examples:

  • https://[your domain]/wp-json/relevanssi/v1/search?keyword=query
  • https://[your domain]/wp-json/relevanssi/v1/search?keyword=query&posts_per_page=5
  • https://[your domain]/wp-json/relevanssi/v1/search?keyword=query&posts_per_page=5&paged=2
  • https://[your domain]/wp-json/relevanssi/v1/search?keyword=query&posts_per_page=5&paged=2&type=post

Demo website:

You can try plugin on our demo website http://demo.erlycoder.com/demo1/. For example you can try the following request:

http://demo.erlycoder.com/demo1/wp-json/relevanssi/v1/search?keyword=test

Installation

  1. Ensure that Relevanssi plugin is installed
  2. Upload the plugin files to the /wp-content/plugins/relevanssi-rest-api directory, or install the plugin through the WordPress plugins screen directly.
  3. Activate the plugin through the ‘Plugins’ screen in WordPress
  4. Plugin does not require any further configuration

FAQ

Knowledge base

You can find answers and solutions in our Knowledge base.

Can I suggest a feature or report a bug?

Yes, you can submit your request on our Contact page.

Reviews

Read all 1 review

Contributors & Developers

“REST API for Relevanssi” is open source software. The following people have contributed to this plugin.

Contributors

Changelog

1.0

  • Release