Funktionsübersicht

In diesem Beitrag möchten wir Ihnen zeigen, wie Sie die Funktionen unserer API mithilfe des REST Webservice ansprechen können.

Authentifizierung

HTTP Anfragen an unsere REST API sind durch eine cookie-basierte Authentifizierung geschützt. Um das Session Cookie zu erhalten, müssen Sie die login-Funktion mit Ihrem Benutzernamen und Ihrem Passwort aufrufen.

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

Im HTTP Response Header Set-Cookie wird Ihnen der Session Cookie zurückgegeben. Der Session Cookie setzt sich aus einem Namen, dem session_name, und einem Wert, der sessid zusammen. Diesen Session Cookie müssen Sie in allen darauffolgenden Anfragen an unsere API im Header Cookie mitsenden.

Rückgabeformate

Unsere API bietet vier Rückgabeformate an. Sie können sich die Informationen aus Ihrem Klick-Tipp Konto in PHP, XML oder JSON ausgeben lassen. Um ein Rückgabeformat auszuwählen, fügen Sie den Namen des jeweiligen Datenformats an das Ende der URL an. Um sich also alle Ihre Double-Opt-in-Prozesse in JSON ausgeben zu lassen, rufen Sie die URL „https://www.klick-tipp.com/api/list.json“ auf.

Funktionen

FunktionURLMethodeParameter
loginhttps://www.klick-tipp.com/api/account/loginPOSTusername, password
logouthttps://www.klick-tipp.com/api/account/logoutPOSTkeine
subscription_process_indexhttps://www.klick-tipp.com/api/listGETkeine
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/tagGETkeine
tag_gethttps://www.klick-tipp.com/api/tag/<tagid>GETtagid wird in URL benötigt
tag_createhttps://www.klick-tipp.com/api/tagPOSTname
tag_updatehttps://www.klick-tipp.com/api/tag/<tagid>PUTname, tagid wird in URL benötigt
tag_deletehttps://www.klick-tipp.com/api/tag/<tagid>DELETEtagid wird in URL benötigt
field_indexhttps://www.klick-tipp.com/api/fieldGETkeine
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/subscriberGETkeine
subscriber_gethttps://www.klick-tipp.com/api/subscriber/<subscriberid>GETsubscriberid wird in URL benötigt
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 wird in URL benötigt
subscriber_deletehttps://www.klick-tipp.com/api/subscriber/<subscriberid>DELETEsubscriberid wird in URL benötigt
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