Skip to main content

Choosing the Right API Key for Connectors

HoppySearch provides two types of API keys: Write API Key and Read API Key, each with different levels of access and permissions. It's essential to choose the appropriate API key based on the functions you intend to use within HoppySearch.

Write API Key​

The Write API Key provides full access to all functions and operations available in HoppySearch. When you configure HoppySearch with a Write API Key, you gain the following capabilities:

  • Adding data to the index.
  • Deleting specific documents from the index.
  • Clearing or deleting all data from the index.
  • Conducting both Normal and Lucene search operations.
  • Retrieving index statistics. With the Write API Key, you have the utmost control and authority over your HoppySearch index. It allows you to perform a wide range of operations, including data management, search, and indexing.

Read API Key​

The Read API Key, on the other hand, offers limited access to certain HoppySearch functions. When you configure HoppySearch with a Read API Key, you can perform the following functions:

  • Conducting Normal Search operations.
  • Conducting Lucene Search operations.
  • Retrieving index statistics. The Read API Key restricts certain actions like adding, deleting, or clearing data from the index. It is primarily intended for users who require search and retrieval capabilities without the need for extensive data management.

Choosing the Right API Key​

To determine which API key to use, consider your specific requirements and the level of control you need over your HoppySearch index:

  • If you require full control over data management, including adding, deleting, and clearing data, choose the Write API Key.
  • If your primary focus is on conducting search operations and retrieving index statistics, the Read API Key is sufficient. By selecting the appropriate API key, you can tailor your HoppySearch experience to align with your specific use case and access only the functions you need.