API
API-Funktionsübersicht: REST API in KlickTipp nutzen
In diesem Beitrag erfährst Du, wie Du die KlickTipp API ganz einfach nutzen kannst. Wir erklären Dir Schritt für Schritt den REST Webservice.
Hier erfährst Du, wie Du Dich ganz unkompliziert authentifizieren kannst. Wir zeigen Dir, welche Rückgabeformate es gibt. Entdecke auch, welche spezifischen API-Funktionen Dir zur Verfügung stehen.
Mit unserer API hast Du die Möglichkeit, Daten abzurufen. Darüber hinaus kannst Du sie aktualisieren oder neue Abonnenten verwalten. Hier zeigen wir Dir, wie Du Deine API-Anfragen ganz einfach korrekt konfigurierst.
Authentifizierung
HTTP Anfragen an unsere REST API sind durch eine cookie-basierte Authentifizierung geschützt. Um Dein Session Cookie zu erhalten, rufe bitte die Login-Funktion mit Deinem Benutzernamen und Passwort auf:
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 findest Du Dein Session Cookie. Dieses besteht aus einem Namen (session_name) und einem Wert (sessid). Bitte sende dieses Session Cookie in allen folgenden Anfragen an unsere API. Du kannst es einfach über das Header Cookie mitsenden.
Rückgabeformate
Unsere API bietet Dir vier verschiedene Rückgabeformate. So kannst Du Dir die Informationen aus Deinem KlickTipp Konto zum Beispiel 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.
Hinweis: Die API gibt im Standard die Werte im XML Format zurück. Wenn Du ein anderes Format als Rückgabe erhalten möchtest, musst Du dieses wie beschrieben definieren. So kannst Du bspw. das Rückgabeformat auf JSON anpassen und damit auch Zeitstempel zu allen Taggings erhalten.
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, tagids |
| 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 |
Mit der API-Funktionsübersicht kannst Du Deine Marketing-Aktivitäten noch effizienter gestalten. Zudem kannst Du sie auch effizient automatisieren.
Die Übersicht über Authentifizierung, Rückgabeformate und Funktionen hilft Dir, alles gezielt umzusetzen. Nutze die API-Dokumentation, um alle relevanten Funktionen optimal zu verwenden.
Falls Du Fragen hast, melde Dich gerne bei uns. Wenn Du Unterstützung benötigst, kannst Du Dich jederzeit gerne an unseren Support wenden. Wir sind für Dich da.
