OpenSearch

OpenSearch is a common standard that is supported by many intranet solutions and applications. The integration is as easy as providing the specific URL and including it as a so-called "Search Provider". Microsoft Sharepoint supports Open Search.

Usage Examples

Setup

1. Go to the app settings of Starmind (Role Setting Administrator is required) and choose "Integration & Services" and then "Open Search"
2. You can then copy the URL from the Page. The URL includes the authentication token.

📘

Running behind a Proxy

If the request times out, you may want to check if you are running behind a proxy. May it is required to whitelist our domain on that proxy.

Configuration

Setting	Description
Short name	The title identifies the search engine.
Description	Short text description of the search engine.
Tags	Keywords to identify and categorize the search content. Single, comma-separated words.
Token	Network-specific authentication token for the search engine to access questions. This is highly sensitive and should be kept confidential
Contact Address	Email address to contact the maintainer of the description document

Technical details

Authentication

Every request against the RSS interface is authenticated with a 40 character random token. This token is network-specific and therefore highly sensitive and should be kept confidential. A user with access to this token, including deactivated users, can view all questions. You can invalidate the token at any time in the application settings of Starmind.

📘

Invalidate the Auth Token

You can invalidate the existing token by clicking on "Generate Token". All old tokens will be invalid after this action.

Example

Open Search will return either an RSS or an ATOM response. The example below shows an RSS response. for the atom response exchange "rss" with "atom in the request URL.

Request

Text

https://{customer}.starmind.com/opensearch/{token}/results/rss?query=starmind&offset=0&limit=100

Response

XML

<?xml version="1.0"?>
<feed xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" xmlns="http://www.w3.org/2005/Atom">
      <title>Search: Starmind</title>
      <link href="http://customer.starmind.com/"/>
      <updated>Thu, 15 Oct 2015 09:26:33 +0200</updated>
      <author>
        <name>Starmind International AG</name>
      </author>
      <opensearch:totalResults>15</opensearch:totalResults>
      <opensearch:startIndex>0</opensearch:startIndex>
      <opensearch:itemsPerPage>20</opensearch:itemsPerPage>
      <opensearch:Query role="request" searchTerms="Starmind" startPage="1"/>
      <link rel="search" type="application/opensearchdescription+xml" href="https://customer.starmind.com/opensearch/afcd5fbca7c5cf385d0e5d37db5c4da9b042b8a0"/>
    <entry>
        <title>How can we implement Starmind in our network?</title>
        <link href="https://customer.starmind.com/question/18637/how-can-we-implement-starmind-in-our-network"/>
        <content type="text">
            We need to implement Starmind as well as possible into our intranet
        </content>
    </entry>
</feed><br>