Welcome to the technical API documentation of ShopOnTarget and ContentOnTarget. 

Our search and recommendation software ShopOnTarget and ContentOnTarget provide a common RESTful API which makes it easy to integrate the service into different types of online systems. With the available API, you are able to analyze any type of textual data, e.g. e-commerce products, blogs post, comments, etc.

Abstract data overview

The central element of the API is the CoreUser element. It provides central access to all your data. The credentials of the CoreUser element was provided per e-mail. You can also find it in your user account at https://www.shopontarget.com or https://www.contentontarget.com.

A CoreUser can have any number of Core elements. Each Core element contains a set of Document elements with common data structure. For example, a Core can contain Documents of type product data, another Core contains Documents of type blog posts, and so on. The data structure of the Document is specified by the CoreSchema. Thus you are able to realize any document structure according to your needs. Each Core requires exactly one CoreSchema. A CoreSchema on the other side can be used in several Cores.

.

For each CoreUser, there is no limitation in the number of Cores and CoreSchemas. However, the core name and the core schema name have to be unique (for the CoreUser) as these names are used as identification criterium.

URL pattern

The CoT API is realized as a REST API. There are two basic URL patterns:

Requests independent of a specific core follow the structure

/api/2.2/[userName]/[userApiHash]/...

In case of core specific requests (this is the most common type of request), the URL structure is:

/api/2.2/[userName]/[coreName]/[coreApiHash]/...

API Type

The CoT API is realized as a JSON RESTful API. Each request has to send the accept header: 

application/json

Only if this header is sent, the response provides the expected result. The data is encoded as UTF-8.

API Request Counter

For each CoreUser, the system logs the requests to the API. The monthly price of the API usage is based on this request counter.

Further Structure

The individual possibilities are described in sub sections. Please follow the links for further information.