klicktipp/php-connector

Simple PHP connector for the KlickTipp REST API (session, API key, partner auth).

Maintainers

Package info

github.com/klicktipp/php-connector

Homepage

Documentation

pkg:composer/klicktipp/php-connector

Statistics

Installs: 4

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

1.0.0 2025-12-01 10:39 UTC

MIT f98f92b74de26f8961ceb9746162e0c3bfee9224

  • KlickTipp Team <info.woop@klicktipp.com>

apinewsletterREST APIemail marketingKlicktipp

This package is not auto-updated.

Last update: 2026-03-30 12:52:53 UTC

README

The KlickTipp PHP Connector is a lightweight PHP interface class for working with the KlickTipp REST API.
It supports three authentication methods:

  • Session login (username + password)
  • API key (listbuilding)
  • Developer key + customer key (partner integrations)

This library is ideal for simple integrations, legacy systems, or server environments without additional HTTP client libraries.

Installation

Install the package via Composer:

composer require klicktipp/php-connector

After installation, include the file as usual:

require 'vendor/klicktipp/php-connector/klicktipp.api.inc';

Quick Start

Login → Add Subscriber → Logout

require 'klicktipp.api.inc';

$k = new KlicktippConnector();
$k->login('username', 'password');

$subscriber = $k->subscribe(
    'email@example.com',
    123,                  // list ID (optional)
    456,                  // tag ID (optional)
    ['fieldFirstName' => 'Max']
);

print_r($subscriber);

$k->logout();

Available Functions (Overview)

🔑 Authentication

  • login($username, $password)
  • logout()

👤 Contacts

  • subscribe($email, $listid = 0, $tagid = 0, $fields = [], $smsnumber = '')
  • subscriber_update($subscriberid, $fields = [], $newemail = '', $newsmsnumber = '')
  • subscriber_get($subscriberid)
  • subscriber_index()
  • subscriber_delete($subscriberid)
  • unsubscribe($email)
  • subscriber_search($email)
  • subscriber_tagged($tagid)

🏷️ Tags

  • tag_index()
  • tag_get($id)
  • tag_create($name, $text)
  • tag_update($id, $name, $text)
  • tag_delete($id)
  • tag($email, $tagids)
  • untag($email, $tagid)

📋 Opt-In Processes

  • subscription_process_index()
  • subscription_process_get($id)
  • subscription_process_redirect($id, $email)

🔑 API Key Functions

  • signin($apikey, $email, $fields = [], $smsnumber = '')
  • signout($apikey, $email)
  • signoff($apikey, $email)

🤝 Developer Key + Customer Key

Use this connector instead of KlicktippConnector:

$k = new KlicktippPartnerConnector($username, $developer_key, $customer_key);

Error Handling

if (!$result) {
    echo $k->get_last_error();
}

Requirements

  • HTTPS support

License

MIT License
(c) KlickTipp Team

Support