commonMain.com.algolia.search.configuration.Credentials.kt Maven / Gradle / Ivy

Go to download

package com.algolia.search.configuration

import com.algolia.search.model.APIKey
import com.algolia.search.model.ApplicationID

/**
 * Configuration used by a client for authenticated request.
 */
public interface Credentials {

    /**
     * [ApplicationID] to target. Is passed as a HTTP header.
     */
    public val applicationID: ApplicationID

    /**
     * [APIKey] for a given [ApplicationID]. Is passed as a HTTP header.
     * To maintain security, never use your Admin [APIKey] on your front end or share it with anyone.
     * In your front end, use the Search-only [APIKey] or any other key that has search-only rights.
     */
    public val apiKey: APIKey
}