API client / Getting started / Customize

Customize your Kotlin 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:

Copy 
1
2
3
4
5
6
7
8

val client =
    ClientSearch(
        ConfigurationSearch(
            applicationID = ApplicationID("YourApplicationID"),
            apiKey = APIKey("YourWriteAPIKey"),
            hosts = listOf(RetryableHost("yourapplication.example.net"))
        )
    )

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

Copy 
1
2
3
4
5
6

val configuration = ConfigurationSearch(
    applicationID = ApplicationID("YourApplicationID"),
    apiKey = APIKey("YourWriteAPIKey"),
    defaultHeaders = mapOf("NAME-OF-HEADER" to "value-of-header")
)
ClientSearch(configuration)

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.

Copy 
1
2
3
4
5
6
7
8

val configuration = ConfigurationSearch(
    applicationID = ApplicationID("YourApplicationID"),
    apiKey = APIKey("YourWriteAPIKey"),
    connectTimeout = 2000 // connection timeout in milliseconds
    readTimeout = 5000, // read timeout in milliseconds
    writeTimeout = 30000 // write timeout in milliseconds
)
ClientSearch(configuration)

Select an HTTP client

The Kotlin API client relies on Ktor for its HTTP layer. Ktor lets you choose and configure the underlying HTTP engine.

See Engines in the Ktor documentation for a list of all supported HTTP engines.

If you don’t explicitly specify a HTTP engine, Ktor selects one for you, depending on which dependencies you installed.

Apache

Copy 
1

implementation "io.ktor:ktor-client-apache:$ktor_version"
Copy 
1
2
3
4
5
6
7
8
9

ClientSearch(
    ConfigurationSearch(
        applicationID = ApplicationID("Your Application ID"),
        apiKey = APIKey("Your API key"),
        engine = Apache.create {
            // Pass additional configuration here.
        }
    )
)

OkHttp

Copy 
1

implementation "io.ktor:ktor-client-okhttp:$ktor_version"
Copy 
1
2
3
4
5
6
7
8
9

ClientSearch(
    ConfigurationSearch(
        applicationID = ApplicationID("Your Application ID"),
        apiKey = APIKey("Your API key"),
        engine = OkHttp.create {
            // Pass additional configuration here.
        }
    )
)

Android HttpUrlConnection

Copy 
1

implementation "io.ktor:ktor-client-android:$ktor_version"
Copy 
1
2
3
4
5
6
7
8
9

ClientSearch(
    ConfigurationSearch(
        applicationID = ApplicationID("Your Application ID"),
        apiKey = APIKey("Your API key"),
        engine = Android.create {
            // Pass additional configuration here.
        }
    )
)
Did you find this page helpful?
Kotlin v2