API
API Function Overview
In our API Function Overview, you’ll learn how to easily use the KlickTipp API to enhance your marketing efforts. We will provide a detailed, step-by-step guide through the REST web service, so you can grasp each concept clearly. Whether you’re a beginner or looking to improve your skills, our instructions will help you use the API with confidence.
Learn how to authenticate with ease, explore the different response formats available to you, and discover which specific API functions you can use to optimize your processes.
With our API, you can retrieve data, update it, or manage new subscribers. We'll also show you how to configure your API requests correctly with ease.
Authentication
HTTP requests to our REST API are secured with cookie-based authentication. To obtain your session cookie, please call the login function using your username and password.
curl -X POST https://api.klicktipp.com/account/login.json \ --data-urlencode "username=username" \ --data-urlencode "password=XXXXXXXX"
Kopieren
In the HTTP response header 'Set-Cookie', you'll find your session cookie. This consists of a name (session_name) and a value (sessid). Please include this session cookie in all subsequent requests to our API by sending it via the 'Cookie' header.
Response Formats
Our API offers four different response formats. You can receive information from your KlickTipp account in PHP, XML, or JSON, for example. To select a response format, append the name of the desired data format to the end of the URL. For instance, to retrieve all your opt-in processes in JSON, call the URL 'https://api.klicktipp.com/list.json'.
Functions
| Function | URL | Method | Parameters |
|---|---|---|---|
| login | https://api.klicktipp.com/account/login | POST | username, password |
| logout | https://api.klicktipp.com/account/logout | POST | none |
| subscription_process_index | https://api.klicktipp.com/list | GET | none |
| subscription_process_get | https://api.klicktipp.com/list/ | GET | listid is required in URL |
| subscription_process_redirect | https://api.klicktipp.com/list/redirect | POST | listid, email |
| tag_index | https://api.klicktipp.com/tag | GET | none |
| tag_get | https://api.klicktipp.com/tag/ | GET | tagid is required in URL |
| tag_create | https://api.klicktipp.com/tag | POST | name |
| tag_update | https://api.klicktipp.com/tag/ | PUT | name, tagid is required in URL |
| tag_delete | https://api.klicktipp.com/tag/ | DELETE | tagid is required in URL |
| field_index | https://api.klicktipp.com/field | GET | none |
| subscribe | https://api.klicktipp.com/subscriber | POST | email, listid, tagid, fields, smsnumber |
| unsubscribe | https://api.klicktipp.com/subscriber/unsubscribe | POST | |
| day | 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 | none |
| subscriber_get | https://api.klicktipp.com/subscriber/ | GET | subscriberid is required in URL |
| 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/ | PUT | fields, newemail, newsmsnumber, subscriberid is required in URL |
| subscriber_delete | https://api.klicktipp.com/subscriber/ | DELETE | subscriberid is required in URL |
| 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 |
This API function overview will help you enhance and automate your marketing activities.
The summary of authentication, response formats, and functions will help you implement everything effectively. With our API documentation, you can make the most of all functions.
