API Function Overview

In this article, we would like to show you how you can access the features of our API using the REST Webservice.

Authentication

HTTP requests to our REST API are protected by cookie-based authentication. To receive the session cookie, you must login with your username and password.

curl -X POST https://app.klicktipp.com/api/account/login.json \ --data-urlencode "username=username" \ --data-urlencode "password=XXXXXXXX" \

The session cookie is returned to you in the HTTP Response Header  Set Cookie. The session cookie consists of a name, the session_name, and a value, the sessid. You must include this session cookie in all subsequent requests to our API in the header cookie.

Return formats

Our API has four return formats. You can have the information from your KlickTipp account returned to you in PHP, XML or JSON. To select a return format, add the name of the data format to the end of the URL. So to return all your double opt-in processes in JSON, run the URL "https://app.klicktipp.com/api/list.json".

Functions

Function URL Method Parameter
Function URL Method Parameter
login https://app.klicktipp.com/api/account/login POST username, password
logout https://app.klicktipp.com/api/account/logout POST none
subscription_process_index https://app.klicktipp.com/api/list GET none
subscription_process_get https://app.klicktipp.com/api/list/ <listid> GET listid wird in URL benötigt
subscription_process_redirect https://app.klicktipp.com/api/list/redirect POST listid, email
tag_index https://app.klicktipp.com/api/tag GET none
tag_get https://app.klicktipp.com/api/tag/ <tagid> GET tagid is required in the URL
tag_create https://app.klicktipp.com/api/tag POST name
tag_update https://app.klicktipp.com/api/tag/ <tagid> PUT name, tagid is required in the URL
tag_delete https://app.klicktippp.com/api/tag/ <tagid> DELETE tagid is required in the URL
field_index https://app.klicktipp/api/field GET none
subscribe https://www.app.klicktipp/api/subscriber POST email, listid, tagid, fields, smsnumber
unsubscribe https://app.klicktipp/api/subscriber/unsubscribe POST email
tag https://app.klicktipp.com/api/subscriber/tag POST email, tagids
untag https://app.klicktipp.com/api/subscriber/untag POST email, tagid
subscriber_index https://app.klicktipp.com/api/subscriber GET none
subscriber_get https://app.klicktipp.com/api/subscriber/ <subscriberid> GET subscriberid is required in the URL
subscriber_search https://app.klicktipp.com/api/subscriber/search POST email
subscriber_tagged https://app.klicktipp.com/api/subscriber/tagged POST tagid
subscriber_update https://app.klicktipp.com/api/subscriber/ <subscriberid> PUT fields, newemail, newsmsnumber, subscriberid is required in the URL
subscriber_delete https://app.klicktipp.com/api/subscriber/ <subscriberid> DELETE subscriberid is required in the URL
signin https://app.klicktipp.com/api/subscriber/signin POST apikey, email, fields, smsnumber
signout https://app.klicktipp.com/api/subscriber/signout POST apikey, email
signoff https://app.klicktipp.com/api/account/signoff POST apikey, email