Set Extra Header | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

client.setExtraHeader(string headerName, string headerValue)

About this method

Sends an extra http header to Algolia, for all subsequent queries.

This method allows you to send the server a specific key/value pair - that we call an extra http header, with every query. By doing this, you are giving the api an additional header that it can later use in certain situations.

Here are some headers with different use cases:

• Setting X-Algolia-UserToken for API key rate limiting purposes.
• Setting X-Algolia-UserToken for analytics purposes. The Analytics API uses the provided value to distinguish between end users. It takes priority over any value in X-Forwarded-For. Use this header if you need to forward the end user’s identity without relying on IP addresses.
• Setting X-Forwarded-For for analytics purposes. If your server sends the end user’s IP along with every search, this enables analytics to distinguish between end users. Otherwise, the analytics will be based on the server IP, not giving you the detail of each user. Alternatively, see X-Algolia-UserToken below.
• Setting X-Forwarded-For for geo purposes. This ensures that the geo search location uses the IP address of the end user, and not that of your backend server. For an example of this, see the aroundLatLngViaIP parameter.

This will eventually be replaced by the requestOptions parameter, allowing you to set the header as part of your query parameters.

Examples

1
2
3
4
5
6
$config = \Algolia\AlgoliaSearch\Config\SearchConfig::create('YourApplicationID', 'YourWriteAPIKey');
$config->setDefaultHeaders([
  'headerName => 'headerValue'
]);

$client = \Algolia\AlgoliaSearch\SearchClient::createWithConfig($config);

1
Algolia.set_extra_header('NAME-OF-HEADER', 'value-of-header')

1
client.setExtraHeader('NAME-OF-HEADER', 'value-of-header');

1
2
3
4
config = SearchConfig('YourApplicationID', 'YourWriteAPIKey')
config.headers['NAME-OF-HEADER'] = 'value-of-header'

client = SearchClient.create_with_config(config)

1
client.setHeader(withName: "NAME-OF-HEADER", to: "value-of-header")

1
client.setHeader("NAME-OF-HEADER", "value-of-header")

1
2
3
4
5
6
var configuration = new SearchConfig("YourApplicationID", "YourWriteAPIKey")
{
    DefaultHeaders = new Dictionary<string, string> { { "NAME-OF-HEADER", "value-of-header" } }
};

SearchClient client = new SearchClient(configuration);

1
2
3
4
5
6
SearchConfig configuration =
new SearchConfig.Builder("YourApplicationID", "YourWriteAPIKey")
  .addExtraHeaders("NAME-OF-HEADER", "value-of-header")
  .build();

SearchClient client = DefaultSearchClient.create(configuration);

1
2
3
4
5
6
7
8
9
config := search.Configuration{
  AppID:  "YourApplicationID",
  APIKey: "YourWriteAPIKey",
  Headers: map[string]string{
    "NAME-OF-HEADER": "value-of-header",
  },
}

client := search.NewClientWithConfig(config)

1
2
3
4
5
6
7
val client = new AlgoliaClient(
  "YourApplicationID",
  "YourWriteAPIKey",
  customHeader = Map(
    "NAME-OF-HEADER" -> "value-of-header"
  )
)

Parameters

Response

No response.