Skip to content

Latest commit

 

History

History
59 lines (46 loc) · 1.77 KB

README.md

File metadata and controls

59 lines (46 loc) · 1.77 KB
Raw

Ask Kodiak Java SDK

License: MIT Javadocs MavenCentral

Overview

The Ask Kodiak Java SDK is a straightforward Java implementation of the Ask Kodiak API for JVM environments. API keys are required to use, you can obtain those keys from Company Settings once you've created an account with Ask Kodiak.

The SDK is implemented with Feign.

Getting Started

Maven:

<dependency>
  <groupId>com.trustedchoice</groupId>
  <artifactId>ask-kodiak-sdk</artifactId>
  <version>1.0.1</version>
  <type>pom</type>
</dependency>

Gradle:

compile 'com.trustedchoice:ask-kodiak-sdk:1.0.1'

Building

$ ./gradlew build

Supported Environments

The Ask Kodiak Java SDK supports Java version 8 and above.

Documentation

**For a full list of options supported by each interface, see the Ask Kodiak API documentation. **

Basic Usage

To construct a client:

AskKodiak askKodiak = AskKodiakClient.getInstance("GROUP ID", "API KEY");

❗ The client constructs a Jackson ObjectMapper for each instance which may perform slowly on your first request due to initial cache builds using reflection. You will likely want to maintain your instance as a singleton.

TODO document example method calls.

License

Licensed under the MIT license