io.instacount.client

Interface InstacountClientParams

All Known Implementing Classes:

InstacountClientParams.AbstractInstacountClientParams

public interface InstacountClientParams

An implementation of RequestInterceptor for supplying proper Instacount Authentication headers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InstacountClientParams.AbstractInstacountClientParams A default implementation of InstacountClientParams.

Method Summary

Methods

Modifier and Type	Method and Description
Client	getClient() The Client that the Instacount API client should use.
String	getClientIdentifier() A unique name for the application making this request.
String	getInstacountApplicationId() Return the application identifier for the Instacount application this client should operate upon.
String	getInstacountReadOnlyApplicationKey() Return the application read-only key for the Instacount application this client should operate upon.
String	getInstacountReadWriteApplicationKey() Return the application read-write key for the Instacount application this client should operate upon.
String	getInstacountRootUrl() The root URL, including http scheme, for the instacount server.

Method Detail

getInstacountApplicationId

String getInstacountApplicationId()

Return the application identifier for the Instacount application this client should operate upon.

Returns:

See Also:

"https://instacount.readme.io/docs/instacount-credentials#application-identifiers"

getInstacountReadOnlyApplicationKey

String getInstacountReadOnlyApplicationKey()

Return the application read-only key for the Instacount application this client should operate upon.

Returns:

See Also:

"https://instacount.readme.io/docs/instacount-credentials#api-keys"

getInstacountReadWriteApplicationKey

String getInstacountReadWriteApplicationKey()

Return the application read-write key for the Instacount application this client should operate upon.

Returns:

See Also:

"https://instacount.readme.io/docs/instacount-credentials#api-keys"

getClientIdentifier

String getClientIdentifier()

A unique name for the application making this request. This is useful for support requests, and will likely be mandatory in the future. For example, "cool-co-java-application".

Returns:

getInstacountRootUrl

String getInstacountRootUrl()

The root URL, including http scheme, for the instacount server.

Returns:

getClient

Client getClient()

The Client that the Instacount API client should use.

Returns: