Skip to end of metadata
Go to start of metadata

Getting started

The REST API is the primary way that data are retrieved from Kiuwan. This guide is intended for developers who want to write applications that can interact with the Kiuwan API. It contains a full reference of API calls. It also shows you how authentication works and all about service quotas.

Get a Kiuwan account

Be sure that you have a Kiuwan account and a Kiuwan username and password. Every REST API request must be authenticated. We recomend to use a different account for development purpose, in order to protect yourself and your production quota service.

Calling style and data format

There are several ways for calling Kiuwan REST API from your application. You can do it directly from Javascript —no server side code is required— or you can use a client library, depending on your server side technology.

The data format is JSON (Javascript Object Notation). It is a common, language-independent data format that provides a simple text representation of arbitrary data structures. For more information, see json.org.

Java client library

The Kiuwan APIs is built on HTTP and JSON, so any standard HTTP client can send requests to it and parse the responses.

However, instead of creating HTTP requests and parsing responses manually, you may want to use the Kiuwan APIs client library. If you are a java developer, client library provides better language integration, improved security, and support for making calls that require user authorization.

Kiuwan Java client for REST API is available in GitHub (https://github.com/kiuwan/java-api-client) under MIT license. If you use Maven, you need to add the following dependency:

If you need to download the jar, you can find in Central Repository.

 

  • No labels