Karotz developper zone

Introduction

There are many ways to obtain an interactiveID, this page describes each of those ways.
The following assumes that you have your external application descriptor deployed in the store. If not, please see Register an application.

Calback Url

It is certainly the easiest way for your app to obtain an interactiveID

using an rfid

If your application is run with a Nanoz, the Karotz platform will call the callback url specified in the descriptor.xml:

	...
    <callback>http://mywebsite.com/callback.php</callback>
	...

The Karotz platform will call:
http://mywebsite.com/callback.php?interactiveid=xxxxx-xxxxx-xxxx-xxxx-xxxxxxx

using the run from website

An other simple way to run your application from the web is to simply make a link to the following url:

http://www.karotz.com/authentication/run/karotz/YOUR-API-KEY

The client will be asked to authenticate himself and the client browser will be redirected to the callback url:
http://mywebsite.com/callback.php?interactiveid=xxxxx-xxxxx-xxxx-xxxx-xxxxxxx

use signed START method

In order to use this method, you need to get the installID of your application.
You have several solution to get this id :

• Use the descriptor callback.
• Add <parameter key="qrcode" value="true"/> into the descriptor. to get the installID as QRcode on the application configuration screen.
• Add <parameter key="showInstallUuid" value="true"/> into the descriptor. to print the installID as text on the application configuration screen.

Signed START method usage.

Other information

interactiveID life cycle is set to 15 minutes.