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://www.klick-tipp.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 Klick-Tipp 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://www.klick-tipp.com/api/list.json".

Functions

FunctionURLMethodParameter
loginhttps://www.klick-tipp.com/api/account/loginPOSTusername, password
logouthttps://www.klick-tipp.com/api/account/logoutPOSTnone
subscription_process_indexhttps://www.klick-tipp.com/api/listGETnone
subscription_process_gethttps://www.klick-tipp.com/api/list/<listid>GETlistid wird in URL benötigt
subscription_process_redirecthttps://www.klick-tipp.com/api/list/redirectPOSTlistid, email
tag_indexhttps://www.klick-tipp.com/api/tagGETnone
tag_gethttps://www.klick-tipp.com/api/tag/<tagid>GETtagid is required in the URL
tag_createhttps://www.klick-tipp.com/api/tagPOSTname
tag_updatehttps://www.klick-tipp.com/api/tag/<tagid>PUTname, tagid is required in the URL
tag_deletehttps://www.klick-tipp.com/api/tag/<tagid>DELETEtagid is required in the URL
field_indexhttps://www.klick-tipp.com/api/fieldGETnone
subscribehttps://www.klick-tipp.com/api/subscriberPOSTemail, listid, tagid, fields, smsnumber
unsubscribehttps://www.klick-tipp.com/api/subscriber/unsubscribePOSTemail
taghttps://www.klick-tipp.com/api/subscriber/tagPOSTemail, tagids
untaghttps://www.klick-tipp.com/api/subscriber/untagPOSTemail, tagid
subscriber_indexhttps://www.klick-tipp.com/api/subscriberGETnone
subscriber_gethttps://www.klick-tipp.com/api/subscriber/<subscriberid>GETsubscriberid is required in the URL
subscriber_searchhttps://www.klick-tipp.com/api/subscriber/searchPOSTemail
subscriber_taggedhttps://www.klick-tipp.com/api/subscriber/taggedPOSTtagid
subscriber_updatehttps://www.klick-tipp.com/api/subscriber/<subscriberid>PUTfields, newemail, newsmsnumber, subscriberid is required in the URL
subscriber_deletehttps://www.klick-tipp.com/api/subscriber/<subscriberid>DELETEsubscriberid is required in the URL
signinhttps://www.klick-tipp.com/api/subscriber/signinPOSTapikey, email, fields, smsnumber
signouthttps://www.klick-tipp.com/api/subscriber/signoutPOSTapikey, email
signoffhttps://www.klick-tipp.com/api/account/signoffPOSTapikey, email