<!-- Source: https://docs.squirro.com/en/latest/technical/integrations/opensearch.html -->
# OpenSearch API

The OpenSearch integration allows you to expose an OpenSearch api endpoint on one or several projects.

## Configuration

To configure the OpenSearch API, follow the steps below:

1. Open your Squirro project.
2. Navigate to the Setup space.
3. Click Settings.
4. Click OpenSearch API in the left menu.

[![image1](https://s3.amazonaws.com/download.squirro.net/docs/migrated-attachments/539951122/540278842.png)](https://s3.amazonaws.com/download.squirro.net/docs/migrated-attachments/539951122/540278842.png)

This studio plugin requires some configuration. To enable it for certain projects you need to add the following configuration snippet to your frontend.ini or common.ini file:

```
[opensearch_api]
# Whitelist all project ids that expose the opensearch API.
# Only configure projects here that contain public data as of
# today we have no authentication in place.
# Multiple projects can be separated by comma.
project_ids = id1,id2
# use a read-only api token for a non-admin user.
token = abc...
# query cache time in seconds
query_cache_ttl = 60
```

Once done, click GO TO DESCRIPTION URL to get the link and content of the OpenSearch API description file.

This file can be used to integrate with any OpenSearch-compatible frameworks.

For example usage, see [Salesforce Federated Search Installation](../../products/installation/salesforce-federated.md#salesforce-federated-search).
