Customize your Ruby client

You can customize the behavior of the API clients by creating a custom configuration This lets you change timeouts, or add HTTP headers.

To modify all requests made with a client, create a custom configuration. To modify individual requests, pass custom request options.

Use a custom host

You can change the default hosts to which the API client connects:

1
2
3
4
5
6
7
8
9
10
11
require 'algolia'

client = Algolia::Search::Client.new(
  Algolia::Search::Config.new({
    application_id: 'YourApplicationID',
    api_key: 'YourAPIKey',
    custom_hosts: [
        'yourdomain.com'
    ]
  })
)

Changing the hosts can be useful if you want to proxy the search requests through another server, for example, to process the request or response, or to perform custom analytics.

Add HTTP headers to every request

Adding HTTP headers to your configuration allow you to set parameters for every request, for example, a user identifier or an IP address. This can be useful for analytics, geographic searches, or to implement API key rate limits.

For an overview of available HTTP headers, see Add HTTP headers to your requests

1
2
config = Algolia::Search::Config.create('YourApplicationID', 'YourWriteAPIKey')
config.headers['NAME-OF-HEADER'] = 'value-of-header'

Change timeouts for all requests

Network connections and DNS resolution can be slow. That’s why the API clients come with default timeouts.

You shouldn’t change the default timeouts, unless you have a good reason.

1
2
3
4
5
6
7
8
9
config = Algolia::Search::Config.new({
   application_id: 'YourApplicationID',
   api_key: 'YourWriteAPIKey',
   read_timeout: 5, # read timeout in seconds
   write_timeout: 30, # write timeout in seconds
   connect_timeout: 2 # connect timeout in seconds
 })

client = Algolia::Search::Client.create_with_config(config)