Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Getting started

...

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

...

Table of Contents

Requirements

To work with the Kiuwan REST API you need a valid Kiuwan account with username and password. Every REST API request must be authenticated.

...

 

We recommend using a different account for development purpose, in order to protect yourself and your production quota service.

Calling

...

style 

There are several ways

...

to call the Kiuwan REST API from your application

...

  • Directly from Javascript

...

  • (no server-side code

...

  • required)
  • Or with a client library, depending on your server-side technology.

Data Format

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

...

are 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, the 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:

Code Block
<dependency>
	<groupId>com.kiuwan</groupId>
	<artifactId>java-api-client</artifactId>
	<version>0.0.4</version>
</dependency>

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

 

Page Tree
root@self