Einführung

- Lesen, bearbeiten und ändern des Profils (Daten und Einstellungen)
- http://en.wikipedia.org/wiki/HTTP_authentication

Server Address (Endpoint)
The base server address is: http://www.clickmap.ch/api/

API Dokumentation

Hier finden sie die Spezifikation mit Beispielen der Clickmap API.

Resource: Tracker

Get Current Sequence

Unterstützt ab API Version 1.0 .

Beschreibung

Gibt die aktuelle Sequenznummer des Trackers zurück.

URL Syntax

/tracker/sequence/get

HTTP Method

GET

Successful HTTP Response

200

Parameters

Examples

Abfragen der aktuellen Sequenznummer eines beliebigen Trackers.

Request

/tracker/sequence/get?authKey={{auth-key}}&apiKey={{api-key}}&tracker={{tracker}}

Body

- oder Parameter

Response (Antwort)

{
    "sequence": 1
}

Bemerkungen

Resource: Tracker

Update Sequence

Unterstützt ab API Version 1.0 .

Beschreibung

Aktualisiert die Sequenznummer des Tracker.

URL Syntax

/tracker/sequence/update

HTTP Method

GET

Successful HTTP Response

200

Parameters

Examples

Sequenznummer eines beliebigen Trackers auf einen neuen Wert setzen.

Request

/tracker/sequence/update?authKey={{auth-key}}&apiKey={{api-key}}&tracker={{tracker}}&sequence={{sequence}}

Body

- oder Parameter

Response (Antwort)

{
    "sequence": 2
}

Bemerkungen

Der Tracker ignoriert Anfragen mit Sequenznummern die kleiner sind als die aktuell gesetzte Sequenznummer. Dies kann Ihnen helfen, zum Beispeil nach dem Veröffentlichen einer neuen Version ihrer Webseite, fehlerfrei Daten aufzuzeichnen.

Resource: Tracker

Increment Sequence

Unterstützt ab API Version 1.0 .

Beschreibung

Inkrementiert die aktuelle Sequenznummer des Trackers.

URL Syntax

/tracker/sequence/increment

HTTP Method

GET

Successful HTTP Response

200

Parameters

Examples

Inkrementieren der aktuellen Sequenznummer eines beliebigen Trackers.

Request

/tracker/sequence/increment?authKey={{auth-key}}&apiKey={{api-key}}&tracker={{tracker}}

Body

- oder Parameter

Response (Antwort)

{
    "sequence": 3
}

Bemerkungen

Der Tracker ignoriert Anfragen mit Sequenznummern die kleiner sind als die aktuell gesetzte Sequenznummer. Dies kann Ihnen helfen, zum Beispeil nach dem Veröffentlichen einer neuen Version ihrer Webseite, fehlerfrei Daten aufzuzeichnen.

Resource: Account

Get Clicks Left

Unterstützt ab API Version 1.0 .

Beschreibung

Returns the amount of clicks left for this cycle.

URL Syntax

/account/clicks/get

HTTP Method

GET

Successful HTTP Response

200

Parameters

Examples

Getting the amount of clicks left for this cycle.

Request

/account/clicks/get?authKey={{auth-key}}&apiKey={{api-key}}

Body

- oder Parameter

Response (Antwort)

{
    "clicks": 12345
}

Bemerkungen

Resource: Tracker

Get Name

Unterstützt ab API Version 1.0 .

Beschreibung

Gibt den aktuellen Namen des Trackers zurück.

URL Syntax

/tracker/name/get

HTTP Method

GET

Successful HTTP Response

200

Parameters

Examples

Abfragen des Trackernamen.

Request

/tracker/name/get?authKey={{auth-key}}&apiKey={{api-key}}&tracker={{tracker}}

Body

- oder Parameter

Response (Antwort)

{
    "name": "Clickmap"
}

Bemerkungen

Resource: Account

Get Message Forwarding Settings

Unterstützt ab API Version 1.0 .

Beschreibung

Get current settings for message forwarding.

URL Syntax

/account/messsage/forward

HTTP Method

GET

Successful HTTP Response

200

Parameters

Examples

Verify if message to e-mail forwarding is activated.

Request

/api/account/messsage/forward?authKey={{auth-key}}&apiKey={{api-key}}

Body

- oder Parameter

Response (Antwort)

{
    "forward": true
}

Bemerkungen

Resource: Tracker

Update tracker's name

Unterstützt ab API Version 1.0 .

Beschreibung

URL Syntax

HTTP Method

UPDATE

Successful HTTP Response

None

Parameters

Examples

Request

/?authKey={{auth-key}}&apiKey={{api-key}}&

Body

Response (Antwort)

Bemerkungen

curl -i -H "Accept: application/json" -X PUT \ -d "authKey={{ auth-key }}&apiKey={{ api-key }}&tracker={{ tracker }}&name={{name}}" \ http://www.clickmap.ch/api/tracker/name/update