PHP Wrapper

Premium- und Deluxe-Kunden stellen wir eine API auf der Basis des Programmierparadigmas REST (Representational State Transfer) zur Verfügung. Damit können Sie Klick-Tipp sehr leicht in jedes beliebige System integrieren.

Die API ermöglicht, auf die Informationen bei Klick-Tipp zuzugreifen. Darüber hinaus können Sie über Ihre Web-Anwendungen auch Daten Ihrer Klick-Tipp-Kontakte aktualisieren. Sie könnten beispielsweise Kunden, die in Ihrem Shop-System ein bestimmtes Produkt gekauft haben, über unsere API mit dem Tag „Kunde“ versehen. So können Sie alle E-Mail-Marketing-Funktionen von Klick-Tipp für Ihre Kunden nutzen.

Wir stellen Ihnen unsere API als RESTful Webservice zu Verfügung. Somit können Sie in jeder beliebigen Umgebung und Programmiersprache – beispielsweise PHP, Javascript oder XML – auf Ihre Daten zugreifen.

PHP-Schnittstellenklasse

Um Ihnen den Einstieg in die Programmierung zu erleichtern, haben wir für Sie eine Schnittstellenklasse in PHP geschrieben. Diese Klasse stellen wir Ihnen auf dieser Seite zum Download zur Verfügung, nachdem Sie sich in Ihr Benutzerkonto eingeloggt haben.

Uploaden Sie die Klasse anschließend per FTP auf Ihrem Webserver in das Verzeichnis, in dem Sie die API nutzen wollen.

Um über Aktualiserungen zu unser API informiert zu werden, tragen Sie sich bitte in das folgende Anmeldeformular ein:

Funktionsweise

Im Folgenden möchten wir Ihnen die Funktionen der Klasse näher beschreiben.

Um auf die Daten eines Empfängers zuzugreifen, müssen Sie sich als Erstes mit Ihrem Benutzernamen und Ihrem Passwort über die Funktion login bei der API anmelden. Das Login wird in der Session gespeichert.

Danach führen Sie die gewünschte Funktion aus. Sie können mehrere API-Aufrufe hintereinander ausführen, ohne sich jedes Mal erneut anmelden zu müssen. Nachdem Sie die gewünschte Funktion ausgeführt haben, melden Sie sich mithilfe der Funktion logout wieder von der API ab.

Der Aufruf der API ist also immer gleich:

<?php

require ('klicktipp.api.inc');

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

// Insert api function here
$result = $connector->apifunction($parameters);

$connector->logout();

?>

Statt $connector->apifunction($parameters); verwenden Sie eine der unten aufgeführten Funktionen.

Funktionen

Im Rahmen unserer API stehen Ihnen die folgenden Funktionen zur Verfügung.

login($username, $password)

Mit dieser Funktion loggen Sie sich mit Ihrem Benutzernamen $username und Ihrem Passwort $password in Ihr Klick-Tipp-Benutzerkonto ein.

  • param mixed $username – Ihr Klick-Tipp-Benutzername
  • param mixed $password – Ihr Klick-Tipp-Passwort

Die Funktion gibt TRUE zurück, wenn das Login erfolgreich war.

Beispiel

<?php

/**
 * Login
 * 
 * @param mixed $username
 * @param mixed $password
 * 
 * @return TRUE on success
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password

$connector = new KlicktippConnector();
$logged_in = $connector->login($username, $password);
$connector->logout();

if ($logged_in) {
  print 'Login successful.';
} else {
  print $connector->get_last_error();
}

?>

logout()

Mit dieser Funktion loggen Sie sich aus Ihrem Klick-Tipp-Benutzerkonto aus.

Die Funktion gibt TRUE zurück, wenn das Ausloggen erfolgreich war.

Beispiel

<?php

/**
 * Log out the user that is currently logged in.
 * 
 * @return TRUE on success
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password

$connector = new KlicktippConnector();
$connector->login($username, $password);
$logged_out = $connector->logout();

if ($logged_out) {
  print 'Logout successful.';
} else {
  print $connector->get_last_error();
}

?>

subscriber_index()

Diese Funktion gibt ein assoziatives Array [id] => [subscriber_id] aller Kontakte in Ihrem Klick-Tipp-Benutzerkonto zurück. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

Beispiel

<?php

/**
 * Get all active subscribers. Login required.
 * 
 * @return array [subscriber_id]
 * Use subscriber_get to get subscriber details.
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password

$connector = new KlicktippConnector();
$connector->login($username, $password);
$subscriber_ids = $connector->subscriber_index();
$connector->logout();

if ($subscriber_ids) {
  print('<pre>'.print_r($subscriber_ids, true).'</pre>');
} else {
  print $connector->get_last_error();
}

?>

subscriber_tagged($tag_id)

Mit dieser Funktion können Sie nach Empfängern suchen, die mit einem bestimmten Tag markiert worden sind. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

  • param mixed $tag_id – ID des Tags

Die Funktion gibt ein assoziatives Array [subscriber_id] => [subscription_timestamp] zurück. Verwenden Sie die Funktion subscriber_get, um die Daten zu einem bestimmten Empfänger auszulesen.

Beispiel

<?php

/**
 * Get all active subscribers tagged with the given tag id. Login required.
 * 
 * @param mixed $tag_id
 * 
 * @return array [subscriber_id] => [subscription_timestamp]
 * Use subscriber_get to get subscriber details.
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password
$tag_id = 123; // Replace 123 with the tag id.

$connector = new KlicktippConnector();
$connector->login($username, $password);
$subscriber = $connector->subscriber_tagged($tag_id);
$connector->logout();

if ($subscriber) {
  print('<pre>'.print_r($subscriber, true).'</pre>');
} else {
  print $connector->get_last_error();
}

?>

subscriber_search($email_address)

Mit dieser Funktion können Sie anhand der E-Mail-Adresse nach einem Empfänger in Ihrem Klick-Tipp-Benutzerkonto suchen. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

  • param mixed $email_address – E-Mail-Adresse des Empfängers

Die Funktion gibt die ID des Empfängers zurück. Verwenden Sie die Funktion subscriber_get, um die Daten zu einem bestimmten Empfänger auszulesen.

Beispiel

<?php

/**
 * Get subscriber id by email address. Login required.
 * 
 * @param mixed $email_address
 * 
 * @return The id of the subscriber.
 * Use subscriber_get to get subscriber details.
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password
$email_address = 'emailaddress@domain.com'; // Replace with the email address.

$connector = new KlicktippConnector();
$connector->login($username, $password);
$subscriber_id = $connector->subscriber_search($email_address);
$connector->logout();

if ($subscriber_id) {
  print $subscriber_id;
} else {
  print $connector->get_last_error();
}

?>

subscriber_get($subscriber_id)

Mit dieser Funktion können Sie alle Informationen zu einem Empfänger auslesen. Nutzen Sie diese Funktion beispielsweise, um herauszufinden, wann ein Kontakt eine bestimmte eMail bekommen, geöffnet oder darin auf einen Link geklickt hat. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

  • param mixed $subscriber_id – ID des Empfängers

Die Funktion gibt ein Objekt mit den Daten des Empfängers zurück. Aufgelistet werden die Inhalte aller Felder sowie assoziative Arrays der Tags, mit denen der Empfänger markiert wurde:

  • manual_tags – assoziatives Array manuelle Tags [tag_id] => [timestamp]
  • smart_links – assoziatives Array SmartLinks [tag_id] => [timestamp]
  • emails_sent – assoziatives Array „Newsletter / Autoresponder erhalten“ [Newsletter / Autoresponder ID] => [timestamp]
  • emails_opened – assoziatives Array „Newsletter / Autoresponder geklickt“ [Newsletter / Autoresponder ID] => [timestamp]
  • emails_clicked – assoziatives Array „Newsletter / Autoresponder geöffnet“ [Newsletter / Autoresponder ID] => [timestamp]
  • emails_viewed – assoziatives Array „Newsletter / Autoresponder im Webbrowser angesehen“ [Newsletter / Autoresponder ID] => [timestamp]
  • conversions – assoziatives Array „Newsletter / Autoresponder Conversion-Pixel geladen“ [Newsletter / Autoresponder ID] => [timestamp]
  • outbound – assoziatives Array „Outbound ausgelöst“ [Outbound ID] => [timestamp]
  • kajabi_activated – assoziatives Array „Kajabi Membership aktiviert“ [Kajabi ID] => [timestamp]
  • kajabi_deactivated – assoziatives Array „Kajabi Membership deaktiviert“ [Outbound ID] => [timestamp]
  • taggingpixel_triggered – assoziatives Array „Tagging-Pixel ausgelöst“ [Tagging-Pixel ID] => [timestamp]
  • notification_emails_sent – assoziatives Array „Email (Marketing Cockpit) erhalten“ [Email ID] => [timestamp]
  • notification_emails_opened – assoziatives Array „Email (Marketing Cockpit) geöffnet“ [Email ID] => [timestamp]
  • notification_emails_clicked – assoziatives Array „Email (Marketing Cockpit) geklickt“ [Email ID] => [timestamp]
  • notification_emails_viewed – assoziatives Array „Email (Marketing Cockpit) im Webbrowser angesehen“ [Email ID] => [timestamp]
  • notification_sms_sent – assoziatives Array „SMS (Marketing Cockpit) erhalten“ [SMS ID] => [timestamp]
  • notification_sms_clicked – assoziatives Array „SMS (Marketing Cockpit) geklickt“ [SMS ID] => [timestamp]
  • campaigns_started – assoziatives Array „Kampagne gestartet“ [Kampagnen ID] => [timestamp]
  • campaigns_finished – assoziatives Array „Kampagne beendet“ [Kampagnen ID] => [timestamp]
  • api_subscriptions – assoziatives Array „Via API-Key eingetragen“ [API-Key ID] => [timestamp]
  • email_subscriptions – assoziatives Array „Via E-Mail eingetragen“ [Eintragung-per-E-Mail ID] => [timestamp]
  • sms_subscriptions – assoziatives Array „Via SMS eingetragen“ [Eintragung-per-SMS ID] => [timestamp]
  • form_subscriptions – assoziatives Array „Via Anmeldeformular“ [Anmeldeformular ID] => [timestamp]
  • facebook_subscriptions – assoziatives Array „Via Facebook-Button eingetragen“ [Facebook-Button ID] => [timestamp]
  • payments – assoziatives Array „Zahlung eingegangen“ [Produkt ID] => [timestamp]
  • refunds – assoziatives Array „Rückzahlung ausgelöst“ [Produkt ID] => [timestamp]
  • chargebacks – assoziatives Array „Chargeback ausgelöst“ [Produkt ID] => [timestamp]
  • rebills_canceled – assoziatives Array „Abo gekündigt“ [Produkt ID] => [timestamp]
  • rebills_resumed – assoziatives Array „Abo wiederaufgenommen“ [Produkt ID] => [timestamp]
  • rebills_expired – assoziatives Array „Letzten Tag des Abo erreicht“ [Produkt ID] => [timestamp]
  • digistore_affiliations – assoziatives Array „Affiliate eines Digistore24-Produkts“ [Produkt ID] => [timestamp]

Die entsprechenden IDs der E-Mails, Anmeldeformulare, Produkte, usw. können Sie aus der 1. Spalte der Tabelle auf den jeweiligen Übersichtsseiten ermitteln.

Beispiel

<?php

/**
 * Get subscriber information. Login required.
 * 
 * @param mixed $subscriber_id
 * 
 * @return subscriber object
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password
$subscriber_id = 123; // Replace 123 with the subscriber id.

$connector = new KlicktippConnector();
$connector->login($username, $password);
$subscriber = $connector->subscriber_get($subscriber_id);
$connector->logout();

if ($subscriber) {
  print('<pre>'.print_r($subscriber, true).'</pre>');
} else {
  print $connector->get_last_error();
}

?>

subscribe($email_address, $list_id = 0, $tag_id = 0, $fields = array(), $smsnumber = '')

Mit dieser Funktion können Sie einen neuen Abonnenten in Ihre ContactCloud eintragen. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

  • param mixed $email_address – E-Mail-Adresse des Empfängers
  • param mixed $list_id – optional: ID des Double-Opt-in-Prozesses. (Wählen Sie im Menü „Automatisierung“ die Option „Double-Opt-in-Prozesse“. Sie finden die ID am Anfang der Tabelle.)
  • param mixed $tag_id – optional: ID des Tags, mit dem Ihre Kontakte markiert werden sollen. (Wählen Sie im Menü „Automatisierung“ die Option „Tags“. Sie finden die ID am Anfang der Tabelle.)
  • param mixed $fields – optional: zusätzliche Daten des Empfängers, zum Beispiel Name, Affiliate-ID, Anschrift, Kundennummer etc. Das Array muss so aufgebaut sein, wie es die Funktion field_index zurückgibt.
  • param mixed $smsnumber – optional: SMS-Mobilnummmer des Empfängers

Die Funktion gibt ein Objekt mit den Daten des Empfängers zurück.

Beispiel

<?php

/**
 * Add subscriber. Login required.
 * 
 * @param mixed $email_email address
 * @param mixed $subscription_process (optional)
 * @param mixed $tag_id (optional)
 * @param mixed $fields (optional)
 * @param mixed $smsnumber (optional)
 * 
 * @return subscriber object
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password
$email_address = 'emailaddress@domain.com'; // Replace with the email address.
$double_optin_process_id = 123;
  // Replace 123 with the id of the double optin prozesses.
$tag_id = 456; // Replace 456 with the tag id.
$fields = array ( // Use field_index to get all custom fields.
  'fieldFirstName' => 'Thomas',
  'fieldLastName' => 'Weber',
);
$smsnumber = '00491631737743';

$connector = new KlicktippConnector();
$connector->login($username, $password);
$subscriber = $connector->subscribe($email_address,
$double_optin_process_id, $tag_id, $fields, $smsnumber);
$connector->logout();

if ($subscriber) {
  print('<pre>'.print_r($subscriber, true).'</pre>');
} else {
  print $connector->get_last_error();
}

?>

signin($api_key, $email_address, $fields = array(), $smsnumber = '')

Mit dieser Funktion können Sie einen neuen Abonnenten mit einem API-Key in Ihre ContactCloud eintragen.

  • param mixed $api_key – API-Key
  • param mixed $email_address – E-Mail-Adresse des Empfängers
  • param mixed $fields – optional: zusätzliche Daten des Empfängers, zum Beispiel Name, Affiliate-ID, Anschrift, Kundennummer etc. Das Array muss so aufgebaut sein, wie es die Funktion field_index zurückgibt.
  • param mixed $smsnumber – optional: SMS-Mobilnummer des Empfängers

Die Funktion gibt die URL der Bestätigungsseite des Double-Opt-in-Prozesses zurück, der im API-Key verwendet wird.

Beispiel

<?php

/**
 * Add subscriber. API Key required.
 * 
 * @param mixed $api_key
 * @param mixed $email_address
 * @param mixed $fields (optional)
 * @param mixed $smsnumber (optional)
 * 
 * @return redirect url as defined in the subscription process used in the API Key.
 */

require ('klicktipp.api.inc');

$api_key = '123xyz'; // Replace 123xyz with the api key.
$email_address = 'emailaddress@domain.com'; // Replace with the email address.
$fields = array ( // Use field_index to get all custom fields.
  'fieldFirstName' => 'Thomas',
  'fieldLastName' => 'Weber',
);
$smsnumber = '00491631737743';

$connector = new KlicktippConnector();
$redirect_url = $connector->signin($api_key, $email_address, $fields, $smsnumber);

if ($redirect_url) {
  print $redirect_url;
} else {
  print $connector->get_last_error();
}

?>

subscriber_update($subscriber_id, $fields = array(), $newemail = '', $newsmsnumber = '')

Mit dieser Funktion können Sie die Daten eines Empfängers aktualisieren. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

  • param mixed $subscriber_id – ID des Empfängers
  • param mixed $fields – zu aktualisierende Felder
  • param mixed $newemail – optional: neue E-Mail-Adresse des Empfängers
  • param mixed $newsmsnumber – optional: neue SMS-Mobilnummer des Empfängers

Die Funktion gibt TRUE zurück, wenn der Vorgang erfolgreich war.

Beispiel

<?php

/**
 * Update subscriber. Login required.
 * 
 * @param mixed $subscriber_id
 * @param mixed $fields (optional)
 * @param mixed $newemail (optional)
 * @param mixed $newsmsnumber (optional)
 * 
 * @return TRUE on success
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password
$subscriber_id = 123; // Replace 123 with the subscriber id.
$newemail = 'newemailaddress@domain.com';
  // Replace with the new email address.
$fields = array ( // Use field_index to get all custom fields.
  'fieldFirstName' => 'Martin',
  'fieldLastName' => 'Meier',
);
$newsmsnumber = '00491631737743';

$connector = new KlicktippConnector();
$connector->login($username, $password);
$updated = $connector->subscriber_update($subscriber_id, $fields, $newemail, $newsmsnumber);
$connector->logout();

if ($updated) {
  print 'Subscriber successfully updated.';
} else {
  print $connector->get_last_error();
}

?>

tag($email_address, $tag_id)

Mit dieser Funktion können Sie einen Kontakt mit manuellen Tags oder mit SmartLinks versehen. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

  • param mixed $email_address – E-Mail-Adresse des Empfängers
  • param mixed $tag_id – die ID des manuellen Tags / SmartLinks. Sie können auch ein Array von Tag IDs übergeben, um gleichzeitig mehrere Tags zuzuweisen (Wählen Sie im Menü „Automatisierung“ die Option „Tags“ beziehungsweise die Option „SmartLinks“. Sie finden die ID am Anfang der Tabelle.)

Die Funktion gibt TRUE zurück, wenn der Vorgang erfolgreich war.

Beispiel

<?php

/**
 * Tag subscriber. Login required.
 *
 * @param mixed $email_address
 * @param mixed $tag_id
 *
 * @return subscriber object
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password
$email_address = 'emailaddress@domain.com'; // Replace with the email address.
$tag_id = 123; // Replace 123 with the tag id.

$connector = new KlicktippConnector();
$connector->login($username, $password);
$result = $connector->tag($email_address, $tag_id);
$connector->logout();

if ($result) {
  print 'Subscriber successfully tagged.';
} else {
  print $connector->get_last_error();
}

?>

untag($email_address, $tag_id)

Mit dieser Funktion können Sie einen manuellen Tag beziehungsweise einen SmartLink von einem Kontakt entfernen. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

  • param mixed $email_address – E-Mail-Adresse des Empfängers
  • param mixed $tag_id – ID des manuellen Tags / SmartLinks (Wählen Sie im Menü „Automatisierung“ die Option „Tags“ beziehungsweise die Option „SmartLinks“. Sie finden die ID am Anfang der Tabelle.)

Die Funktion gibt TRUE zurück, wenn der Vorgang erfolgreich war.

Beispiel

<?php

/**
 * Remove tag from subscriber. Login required.
 *
 * @param mixed $email_address
 * @param mixed $tag_id
 *
 * @return TRUE on success.
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password
$email_address = 'emailaddress@domain.com'; // Replace with the email address.
$tag_id = 123; // Replace 123 with the tag id.

$connector = new KlicktippConnector();
$connector->login($username, $password);
$untagged = $connector->untag($email_address, $tag_id);
$connector->logout();

if ($untagged) {
  print 'Tag successfully removed from subscriber.';
} else {
  print $connector->get_last_error();
}

?>

signout($api_key, $email_address)

Mit dieser Funktion können Sie einen manuellen Tag beziehungsweise einen SmartLink mit einem API-Key von einem Kontakt entfernen.

  • param mixed $api_key – API-Key
  • param mixed $email_address – E-Mail-Adresse des Empfängers

Die Funktion gibt TRUE zurück, wenn der Vorgang erfolgreich war.

Beispiel

<?php

/**
 * Remove tag from subscriber. API Key required.
 *
 * @param mixed $api_key
 * @param mixed $email_address
 *
 * @return TRUE on success
 */

require ('klicktipp.api.inc');

$api_key = '123xyz'; // Replace 123xyz with the api key.
$email_address = 'emailaddress@domain.com'; // Replace with the email address.

$connector = new KlicktippConnector();
$untagged = $connector->signout($api_key, $email_address);

if ($untagged) {
  print 'Tag successfully removed from subscriber.';
} else {
  print $connector->get_last_error();
}

?>

unsubscribe($email_address)

Mit dieser Funktion können Sie einen Empfänger austragen. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

  • param mixed $email_address – E-Mail-Adresse des Empfängers

Die Funktion gibt TRUE zurück, wenn der Vorgang erfolgreich war.

Beispiel

<?php

/**
 * Unsubscribe subscriber. Login required.
 *
 * @param mixed $email_address
 *
 * @return TRUE on success
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password
$email_address = 'emailaddress@domain.com'; // Replace with the email address.

$connector = new KlicktippConnector();
$connector->login($username, $password);
$unsubscribed = $connector->unsubscribe($email_address);
$connector->logout();

if ($unsubscribed) {
  print 'Subscriber successfully unsubscribed.';
} else {
  print $connector->get_last_error();
}

?>

signoff($api_key, $email_address)

Mit dieser Funktion können Sie einen Empfänger mit einem API-Key austragen.

  • param mixed $api_key – API-Key
  • param mixed $email_address – E-Mail-Adresse des Empfängers

Die Funktion gibt TRUE zurück, wenn der Vorgang erfolgreich war.

Beispiel

<?php

/**
 * Unsubscribe subscriber. API Key required.
 *
 * @param mixed $api_key
 * @param mixed $email_address
 *
 * @return TRUE on success
 */

require ('klicktipp.api.inc');

$api_key = '123xyz'; // Replace 123xyz with the api key.
$email_address = 'emailaddress@domain.com'; // Replace with the email address.

$connector = new KlicktippConnector();
$unsubscribed = $connector->signoff($api_key, $email_address);

if ($unsubscribed) {
  print 'Subscriber successfully unsubscribed.';
} else {
  print $connector->get_last_error();
}

?>

subscriber_delete($subscriber_id)

Mit dieser Funktion können Sie einen Empfänger löschen. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

  • param mixed $subscriber_id – ID des Empfängers

Die Funktion gibt TRUE zurück, wenn der Vorgang erfolgreich war.

<?php

/**
 * Delete subscriber. Login required.
 *
 * @param mixed $subscriber_id
 *
 * @return TRUE on success.
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password
$subscriber_id = 123; // Replace 123 with the subscriber id.

$connector = new KlicktippConnector();
$connector->login($username, $password);
$deleted = $connector->subscriber_delete($subscriber_id);
$connector->logout();

if ($deleted) {
  print 'Subscriber successfully deleted.';
} else {
  print $connector->get_last_error();
}

?>

tag_index()

Diese Funktion gibt ein assoziatives Array [tag_id] => [tag_name] Ihrer manuellen Tags sowie Ihrer SmartLinks zurück. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

Beispiel

<?php

/**
 * Get all manual tags and smart links of the user. Login required.
 *
 * @return array [tag_id] => [tag_name]
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password

$connector = new KlicktippConnector();
$connector->login($username, $password);
$tags = $connector->tag_index();
$connector->logout();

if ($tags) {
  print('<pre>'.print_r($tags, true).'</pre>');
} else {
  print $connector->get_last_error();
}

?>

tag_get($tag_id)

Diese Funktion gibt den Namen und die Beschreibung eines Tags zurück. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

  • param mixed $tag_id – ID des Tags

Beispiel

<?php

/**
 * Get tag definition. Login required.
 *
 * @param mixed $tag_id
 *
 * @return tag object
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password
$tag_id = 123; // Replace 123 with the tag id.

$connector = new KlicktippConnector();
$connector->login($username, $password);
$tag = $connector->tag_get($tag_id);
$connector->logout();

if ($tag) {
  print('<pre>'.print_r($tag, true).'</pre>');
} else {
  print $connector->get_last_error();
}

?>

tag_create($name, $text = '')

Mit dieser Funktion können Sie einen neuen manuellen Tag erstellen. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

  • param mixed $name – Name des manuellen Tags
  • param mixed $text – optional: zusätzliche Informationen

Die Funktion gibt die ID des neuen Tags zurück.

Beispiel

<?php

/**
 * Create manual tag. Login required.
 *
 * @param string $name (name of the tag)
 * @param mixed $text (optional: additional information)
 *
 * @return mixed tag id of the new tag
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password
$name = 'Tag 123';
$text = 'Further information ...';

$connector = new KlicktippConnector();
$connector->login($username, $password);
$tag_id = $connector->tag_create($name, $text);
$connector->logout();

if ($tag_id) {
  print $tag_id;
} else {
  print $connector->get_last_error();
}

?>

tag_update($tag_id, $name = '', $text = '')

Mit dieser Funktion können Sie einen manuellen Tag beziehungsweise einen SmartLink aktualisieren. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

  • param mixed $tag_id – ID des manuellen Tags / SmartLinks (Wählen Sie im Menü „Automatisierung“ die Option „Tags“ beziehungsweise die Option „SmartLinks“. Sie finden die ID am Anfang der Tabelle.)
  • param mixed $name – optional: Name des manuellen Tags / SmartLinks
  • param mixed $text – optional: zusätzliche Informationen

Die Funktion gibt TRUE zurück, wenn der Vorgang erfolgreich war.

Beispiel

<?php

/**
 * Update tag. Login required.
 *
 * @param mixed $tag_id
 * @param mixed $name (optional: New tag name. Set empty to leave unchanged.)
 * @param mixed $text (optional: New tag description. Set empty to leave unchanged.)
 *
 * @return TRUE on success
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password
$tag_id = 123; // Replace 123 with the tag id.
$name = 'Tag 123';
$text = 'Further information ...';

$connector = new KlicktippConnector();
$connector->login($username, $password);
$updated = $connector->tag_update($tag_id, $name, $text);
$connector->logout();

if ($updated) {
  print 'Tag successfully updated.';
} else {
  print $connector->get_last_error();
}

?>

tag_delete($tag_id)

Mit dieser Funktion können Sie einen manuellen Tag beziehungsweise einen SmartLink löschen. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

  • param mixed $tag_id – ID des manuellen Tags / SmartLinks (Wählen Sie im Menü „Automatisierung“ die Option „Tags“ beziehungsweise die Option „SmartLinks“. Sie finden die ID am Anfang der Tabelle.)

Die Funktion gibt TRUE zurück, wenn der Vorgang erfolgreich war.

Beispiel

<?php

/**
 * Delete tag. Login required.
 *
 * @param mixed $tag_id
 *
 * @return TRUE on success
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password
$tag_id = 290347; // Replace 123 with the tag id.

$connector = new KlicktippConnector();
$connector->login($username, $password);
$deleted = $connector->tag_delete($tag_id);
$connector->logout();

if ($deleted) {
  print 'Tag successfully deleted.';
} else {
  print $connector->get_last_error();
}

?>

subscription_process_index()

Diese Funktion gibt ein assoziatives Array [double_optin_process_id] => [double_optin_process_name] Ihrer Double-Opt-in-Prozesse zurück. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

Beispiel

<?php

/**
 * Get all double optin processes. Login required.
 *
 * @return array [double_optin_process_id] => [double_optin_process_name]
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password

$connector = new KlicktippConnector();
$connector->login($username, $password);
$subscription_processes = $connector->subscription_process_index();
$connector->logout();

if ($subscription_processes) {
  print('<pre>'.print_r($subscription_processes, true).'</pre>');
} else {
  print $connector->get_last_error();
}

?>

subscription_process_get($list_id)

Diese Funktion gibt den Namen eines Double-Opt-in-Prozesses zurück. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

  • param mixed $list_id – ID Ihres Double-Opt-in-Prozesses (Wählen Sie im Menü „Automatisierung“ die Option „Double-Opt-in-Prozesse“. Sie finden die ID am Anfang der Tabelle.)

Beispiel

<?php

/**
 * Get double optin process definition. Login required.
 *
 * @param mixed $double_optin_process_id
 *
 * @return double optin process object
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password
$double_optin_process_id = 123; // Replace 123 with the id of the double optin prozesses.

$connector = new KlicktippConnector();
$connector->login($username, $password);
$subscription_process = $connector->subscription_process_get($double_optin_process_id);
$connector->logout();

if ($subscription_process) {
  print('<pre>'.print_r($subscription_process, true).'</pre>');
} else {
  print $connector->get_last_error();
}

?>

subscription_process_redirect($listid, $email)

Mit dieser Funktion erhalten Sie die URL der Bestätigungsseite des Double-Opt-in-Prozesses für einen bestimmten Empfänger.

  • param mixed $listid – ID Ihres Double-Opt-in-Prozesses (Wählen Sie im Menü „Automatisierung“ die Option „Double-Opt-in-Prozesse“. Sie finden die ID am Anfang der Tabelle.)
  • param mixed $email – E-Mail-Adresse des Empfängers

Die Funktion gibt die URL der Bestätigungsseite des Double-Opt-in-Prozesses für den gegebenen Empfänger zurück.

Beispiel

<?php

/**
* Get double optin process redirect url. Login required.
*
* @param mixed $listid
* @param mixed $email
*
* @return redirect url as defined in the subscription process.
*/

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password
$double_optin_process_id = 123; // Replace 123 with the id of the double optin process.
$email = 'emailaddress@domain.com'; // Replace with the email address.

$connector = new KlicktippConnector();
$redirect_url = $connector->subscription_process_redirect($double_optin_process_id, $email);

if ($redirect_url) {
  print $redirect_url;
} else {
  print $connector->get_last_error();
}

?>

field_index()

Diese Funktion gibt ein assoziatives Array [field_identifier] => [field_name] der Felder in Ihrer ContactCloud zurück. Sie müssen sich mit login einloggen, um diese Funktion nutzen zu können.

Beispiel

<?php

/**
 * Get all contact fields. Login required.
 *
 * @return array [field_identifier] => [field_name]
 */

require ('klicktipp.api.inc');

$username = 'username'; // Replace with username
$password = 'password'; // Replace with password

$connector = new KlicktippConnector();
$connector->login($username, $password);
$fields = $connector->field_index();
$connector->logout();

if ($fields) {
  print('<pre>'.print_r($fields, true).'</pre>');
} else {
  print $connector->get_last_error();
}

?>

Wir hoffen, dass unsere Beschreibung unserer API-Schnittstelle für Sie hilfreich ist. Wenn Sie Fragen zu unserer API haben oder wenn Sie ein Angebot zur Programmierung einer Schnittstelle für Ihr Fremdsystem von uns wünschen, dann senden Sie eine Nachricht an unsere Kundenbetreuung über unser Kontaktformular.

War dieser Artikel hilfreich?