README

ConvertLoop REST API的PHP客户端。您可以在http://convertloop.co注册ConvertLoop账户。

安装

要求

PHP 5.3.3及更高版本。

Composer

使用Composer安装此库，请运行以下命令

composer require convertloop/convertloop-php

使用时，使用Composer的自动加载

require_once('vendor/autoload.php');

入门

首先，您需要创建一个ConvertLoop\ConvertLoop类的实例，传递您的app_id和api_key

$convertloop = new \ConvertLoop\ConvertLoop("app_id", "api_key", "v1");

现在您可以开始调用API方法了

创建或更新人员

您需要传递以下之一：pid、user_id或email以标识用户。当您正在更新您网站上的访客时使用pid（您可以从cookie dp_pid中获取此值）。使用user_id来匹配您应用程序中用户的id。

$person = array(
    "email" => "german.escobar@convertloop.co",
    "first_name" => "German",
    "last_name" => "Escobar",
    "plan" => "free"
);
$convertloop->people()->createOrUpdate($person);

与pid、user_id、email、first_seen_at、last_seen_at、add_to_segments和remove_from_segments不同的任何键都将被视为人员的自定义属性。

您可以使用add_to_segments和remove_from_segments键向段中添加或移除人员

$person = array(
    "email" => "german.escobar@convertloop.co",
    "add_to_segments" => array("Learn Something"),
    "remove_from_segments" => array("Segment 1")
);
$convertloop->people()->createOrUpdate($person);

跟踪事件

您可以跟踪任何人员的任何事件

$person = array("email" => "german.escobar@convertloop.co");
$event = array(
    "name" => "Billed",
    "person" => $person,
    "metadata" => array("credits" => 1000),
    "ocurred_at" => time()
);
$convertloop->eventLogs()->send($event);

如果不指定ocurred_at键，将使用当前时间。您可以使用person键向该人员添加自定义属性，或将该人员添加或从段中移除。