Wikitude Cloud Recognition

The Wikitude Cloud Recognition service is a cloud-based service provided by Wikitude, which recognizes images sent from Android and iOS apps using the Wikitude SDK. The recognized images are then tracked in the live camera feed and can be used for augmented reality experiences.

This documentation focuses on the RESTful API called Manager API, which is used to interact on a backend level with the Cloud Recognition service.

General Definitions

Manager API: A RESTful web API allowing developers to interact with the Cloud Recognition server for managing Targets, TargetCollections and Cloud Archives. Only you as a developer uses this API. None of your users of your app will interact with this API.

Client API: The Client API is the interface between the Wikitude SDK and the Cloud Recognition Service. The API itself is encapsulated in the Wikitude SDK class AR.CloudTracker and not directly accessible. Calls on the client API are called Scans.

Region: Wikitude is providing several hosting locations for its Cloud Recognition services to cut down unwanted network latency. As a developer you need to choose on which Region you and your customers want to operate.

Getting Started with the Cloud Recognition Service

Regional availability of Wikitude Cloud Recognition Service

As as a developer using Wikitude Cloud Recognition Service you need to choose which server location you want to use for your projects. Wikitude operates several servers running Wikitude Cloud Recognition Service in different locations world-wide.

As the region servers are separated content which is stored on one region servers is only available on this particular server. Content is not synced across regions. You can choose from the following Regions

The servers for each region have separate dedicated domain names and therefore different configurations.

Region Target Manager Manager API SDK Setting
Americas targetmanager‑us.wikitude.com https://api-us.wikitude.com Americas
China targetmanager‑cn.wikitude.com https://api-cn.wikitude.com China
Europe targetmanager.wikitude.com https://api.wikitude.com or https://api-eu.wikitude.com Europe

Preparation

  1. Create a free Wikitude developer account or log-in if you are a returning developer
  2. Get the API tokens for the Manager API and the Client API to start your project. Read more on authentication
  3. Test the API for free using Wikitude's sample integrations
  4. Once you finished your integration, purchase a commercial token.

First Steps and General Usage

  1. Get familiar with the Manager API calls in the API Reference.
  2. Create a first Target Collection using the Create Target Collection endpoint and note down the ID of the Target Collection
  3. Create targets using the Create Target endpoint for that particular Target Collection
  4. Important: Generate a Cloud Archive for your Target Collection
  5. Go to the Wikitude SDK and create an Android or iOS project
  6. Use the Client API token to authenticate your Android or iOS project
  7. Use your Target Collection ID to recognize images

For more information on the available endpoints and how to work with the Manager API see the workflow section.

Instead of creating a TargetCollection, adding one or more Targets, and generating a Cloud Archive by calling the REST API, the Wikitude Targetmanager can be used to perform these steps (1-4) in the browser alternatively.

In case you would like to immediately test the API calls we recommend the tool Postman. It helps you to quickly construct the requests and analyze the responses.

Authentication

The Cloud Recognition Service knows two authentication tokens, that you need in order to work with the service

Authentication on the Manager API

The Manager API token must be added to each call towards the Wikitude Cloud Recognition Manager API. The token authenticates the user account that is using the API.

Authentication on the Client API

The Client API token must be added to your app project using the Wikitude SDK. This token is needed additionally beside the SDK license key when working with the AR.CloudTracker class.

Quota and Limits

General Upload Limit

The Wikitude Cloud Recognition will not accept images bigger than 1024kB (1 MB). Trying to upload images exceeding this file size will result in a HTTP status code 400 together with an error message FILE_SIZE_LIMIT_EXCEED.

Limits for the Wikitude Cloud Recognition Service

There are two main limitations for the Wikitude Cloud Recognition service that you need to be aware of:

Maximum Number of Targets in a Target Collection

A target collection can't exceed 50,000 targets.

Free Trial License for Cloud Recognition

Wikitude provides a trial token for each developer account to try out the Cloud Recognition for free. This trial token has set a quota limit that allows developers to try and test the functionality of the service. Limitations for trial accounts

To get your trial token for the REST, please visit the License page. The trial token is directly integrated into the Target Manager Frontend.

Commercial Licenses

For production systems, we offer commercial licenses with various quota limits for purchase.

Product Targets Scans
Cloud Recognition 1000 1,000 1,000,000
Cloud Recognition 10000 10,000 1,000,000
Cloud Recognition 25000 25,000 1,000,000
Cloud Recognition 50000 50,000 1,000,000
Cloud Recognition 100000 (*) 100,000 1,000,000

(*) Maximum number of targets per target collection can't exceed 50,000