Search API

Search services allow searching and retrieving information on various objects such as organizations, buildings, public places, etc.

Architecture

Search services architecture consists of two services:

• Catalog APIs provide RESTful APIs for applications.
• Search API is a search engine that processes requests made by Catalog APIs.

With Search API

For more information on installing search services with Search API, see Installing search API services.

With Search API v8

Search API v8 is an updated version of Search API with improved search results accuracy, currently in beta testing.

Search API v8 component interactions

Catalog APIs send an HTTP request to IngressRouter. IngressRouter sends the request to SegmentDetector, which enriches it with data from the requested segments, and then forwards it to Head. Head splits the request into parts and sends them to a group of Unisearchers. Each Unisearcher in the group searches its available indexes and returns the results to Head. Head collects the responses and sends them to IngressRouter, which returns the results to Catalog APIs.

Controller checks for new versions of feeds (raw data) and issues indexing tasks. DataAdapter and Indexer access Object Storage (S3 compatible storage containing the raw feeds), retrieve the feeds, and index them. The resulting indexes are stored in FilesStorage, from which the other services retrieve them. Indexes are updated in real time, without restarting the services.

For more information on installing search services with the updated Search API version, see Installing search API services (with Search API v8).

Dependencies

• For Search API and Search API v8

  • S3 compatible storage for storing the search indexes (Installation Artifacts Storage).

• For Catalog APIs

  • Shared infrastructure:

    • PostgreSQL data storage for storing object data with the PostGIS extension.
    Software alternatives

    Instead of PostgreSQL, you can use an alternative from the unified register of Russian programs. For available alternatives, see the System requirements section.

  • Services:

    • License service
    • API Keys service
    • Statistics Collection service
    • Search API

For more information on how to check requirements for each service, refer to the System requirements document.

What's next?

• Find out how to install or update the services:

  • Installing search API
  • Updating search API

• Read more about On-Premise:

  • Software suite architecture
  • System requirements