Search API Tab

Studio > Navigation Pane > Search App > Settings > App Settings > Search API Tab.

The Search API tab displays the SearchStax Studio Search, Update and Suggest Endpoints. Each has a copy button to easily copy to clipboard and curl examples provided.

  • Search Endpoint: This endpoint, ending in /emselect, is used to send Solr queries to the App’s database of searches, content items, feedback, and so forth.
  • Update Endpoint: The Update endpoint can be used to upload data to the Search App.
  • Suggest Endpoint: This one, ending in /emsuggest, is used to ask for suggestions when a search query returns no results.

If you scroll down, you’ll find the authentication methods for the endpoints: Token Authentication and Basic Authentication

Token Authentication

For apps using Token Authentication, the Access Tokens are cryptographically secure 20 bytes tokens that do not expire, but can be rotated.

Token Management

  • It’s recommended to use the Read Only token for the Select and Suggest endpoints
  • The Read & Write token is used for the Update endpoint

You can manage your tokens and rotate them if needed.

  1. Click on the Create Token button – this will create an enabled Read Only token by default.
  2. If you need to change an access right for a token, select the appropriate access right in the dropdown.
  3. Leave the old token enabled until ready to rotate.
  4. Once ready, disable the token by clicking on the toggle (turning it to red) or delete the token.

*If you are rotating your token, the new token will need to be deployed out through your dev process as well

Basic Authentication

For apps using Basic Authentication, the Search APIs are protected using a sets of an auto-generated User-ID and passwords set by the user.

Search API Tab

You may change the passwords (but not the user IDs) on this screen. Click the Save button when finished. 

Search API Tab

When you update the schema of an index (populate your app with new data), click the Reload Schema button to copy the changes into SearchStax Studio.

Questions?

Do not hesitate to contact the SearchStax Support Desk.