API
API Funktionsübersicht
In diesem Beitrag möchten wir Dir zeigen, wie Du die Funktionen unserer API mithilfe des REST Webservice ansprechen kannst.
Authentifizierung
HTTP Anfragen an unsere REST API sind durch eine cookie-basierte Authentifizierung geschützt. Um das Session Cookie zu erhalten, musst Du die login-Funktion mit Deinem Benutzernamen und Deinem Passwort aufrufen:
curl -X POST https://api.klicktipp.com/account/login.json \ --data-urlencode "username=username" \ --data-urlencode "password=XXXXXXXX"
Kopieren
Im HTTP Response Header Set-Cookie wird Dir 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 musst Du in allen darauffolgenden Anfragen an unsere API im Header Cookie mitsenden.
Rückgabeformate
Unsere API bietet vier Rückgabeformate an. Du kannst Dir die Informationen aus Deinem KlickTipp Konto in PHP, XML oder JSON ausgeben lassen. Um ein Rückgabeformat auszuwählen, füge den Namen des jeweiligen Datenformats an das Ende der URL an. Um Dir also alle Deine Opt-in-Prozesse in JSON ausgeben zu lassen, rufe die URL „https://api.klicktipp.com/list .json“ auf.
Funktionen
| Funktion | URL | Methode | Parameter |
|---|---|---|---|
| login | https://api.klicktipp.com/account/login | POST | username, password |
| logout | https://api.klicktipp.com/account/logout | POST | keine |
| subscription_process_index | https://api.klicktipp.com/list | GET | keine |
| subscription_process_get | https://api.klicktipp.com/list/ | GET | listid wird in URL benötigt |
| subscription_process_redirect | https://api.klicktipp.com/list/redirect | POST | listid, email |
| tag_index | https://api.klicktipp.com/tag | GET | keine |
| tag_get | https://api.klicktipp.com/tag/ <tagid> | GET | tagid wird in URL benötigt |
| tag_create | https://api.klicktipp.com/tag | POST | name |
| tag_update | https://api.klicktipp.com/tag/ <tagid> | PUT | name, tagid wird in URL benötigt |
| tag_delete | https://api.klicktipp.com/tag/ <tagid> | DELETE | tagid wird in URL benötigt |
| field_index | https://api.klicktipp.com/field | GET | keine |
| subscribe | https://api.klicktipp.com/subscriber | POST | email, listid, tagid, fields, smsnumber |
| unsubscribe | https://api.klicktipp.com/subscriber/unsubscribe | POST | |
| tag | https://api.klicktipp.com/subscriber/tag | POST | email, tagid |
| untag | https://api.klicktipp.com/subscriber/untag | POST | email, tagid |
| subscriber_index | https://api.klicktipp.com/subscriber | GET | keine |
| subscriber_get | https://api.klicktipp.com/subscriber/ <subscriberid> | GET | subscriberid wird in URL benötigt |
| subscriber_search | https://api.klicktipp.com/subscriber/search | POST | |
| subscriber_tagged | https://api.klicktipp.com/subscriber/tagged | POST | tagid |
| subscriber_update | https://api.klicktipp.com/subscriber/ <subscriberid> | PUT | fields, newemail, newsmsnumber, subscriberid wird in URL benötigt |
| subscriber_delete | https://api.klicktipp.com/subscriber/ <subscriberid> | DELETE | subscriberid wird in URL benötigt |
| signin | https://api.klicktipp.com/subscriber/signin | POST | apikey, email, fields, smsnumber |
| signout | https://api.klicktipp.com/subscriber/signout | POST | apikey, email |
| signoff | https://api.klicktipp.com/subscriber/signoff | POST | apikey, email |
