leadrockmain/leadrock-integration

Leadrock API 集成包

0.2.24 2023-10-23 13:08 UTC

README

API 文档

安装指南

推荐通过 Composer 安装包。

# Install Composer
curl -sS https://getcomposer.org/installer | php

接下来,运行 Composer 命令安装包的最新稳定版本

php composer.phar require leadrockmain/leadrock-integration

安装后,您需要要求 Composer 的自动加载器

require 'vendor/autoload.php';

然后您可以使用 composer 更新包

composer.phar update

查看 example 文件夹中的集成选项,以便快速使用。

无需 composer 的自动更新脚本文件

您可以从我们的服务器下载自动更新/安装文件: https://leadrock.com/integration/updater。将此文件上传到您的着陆页,为脚本文件夹授予写访问权限,并从浏览器调用它,如下所示:http://example.com/landing/leadrock-install.php

脚本将下载集成包 leadrock-integration.phar,您可以使用它代替 composer 自动加载类,就像任何其他 PHP 文件一样。

<?php
include 'leadrock-integration.phar';

您可以在任何时候再次调用安装脚本并获取更新的 leadrock-integration.phar 文件。

通过配置文件完成完整快速集成

您可以使用配置文件,其中包含在您的着陆页上全局使用的设置,包括感谢页面,以避免独立的着陆页集成和感谢页面集成。查看默认配置

<?php
return [
    'layout' => 'landing', // integration type (landing or prelanding)
    'thankyou_page' => 'thankyou.php', // your thankyou page
 
    'track_param' => 'track_id', // url param where track ID can be found
 
    'facebook_id' => '123321123321,123321123322', // multiple ids can be separated by comma
    'facebook_from_param' => 'fbpixel', // url param where Facebook pixel ID can be found
    'facebook_landing_goal' => 'PageView', // Facebook event on landing page
    'facebook_thankyou_goal' => 'Purchase', // Facebook event on thankyou page
 
    'api_key' => '1278g3',
    'api_secret' => 'o4ircshboiuerbvs',
    'save_in_file' => 'leads.log', // file path to backup lead data
 
    'form' => [ //form param names as param => field_name
        //<input name="phone" />
        'user_phone' => 'phone',
        //<input name="name" />
        'user_name' => 'name',
        //<input name="email" />
        'user_email' => 'email',
        //<input name="other" />
        'other' => 'other',
        //<input name="price" />
        'price' => 'price',
    ]
];

还要创建两个文件

index.php

<?php
include 'vendor/autoload.php';

$config = new \Leadrock\Items\Config('config.php');
$integration = new \Leadrock\Integration($config);
 
include 'landing.html';
 
$integration->end();

thankyou.php

<?php
include 'vendor/autoload.php';

$config = new \Leadrock\Items\Config('config.php');
$integration = new \Leadrock\Integration($config);
 
include 'thankyou.html';
 
$integration->end();

所有其他设置将由配置和集成脚本完成。要使用更详细的设置,请使用下面的集成。

着陆页集成

index.php 与您的 HTML 文件一起添加,将 HTML 模板重命名为类似 template.html 的内容,这样您就可以将 HTML 代码与 PHP 集成代码分离,以便于使用。

在 PHP 文件中,您应使用头部和尾部集成,在头部指定设置,并将您的模板文件包含在中间

<?php
include 'vendor/autoload.php';

$integration = new \Leadrock\Layouts\Landing();
$integration
    ->findTrackIn('track_id')
    ->addProvider(new \Leadrock\Providers\File('leads_log.txt'))
    ->addProvider(new \Leadrock\Providers\Leadrock('1278g3', 'so4ircshboiuerbvs'))
    ->setFormField('user_name', 'name')
    ->setFormField('user_phone', 'phone')
    ->setFormField('other', 'other');
 
include 'template.html';
 
$integration->end();

上述代码将捕获提供的跟踪 ID 从 GET 参数(如上所述的 track_id),将其存储在 cookies 和会话存储中,并将提供的额外 Facebook 数据(如果默认 GET 参数中提供了)添加到页面末尾,然后渲染模板给用户。在 POST 请求中,表单数据将根据字段设置进行解析,并创建新的潜在客户,然后将其提交到文件和 API 请求。

有两种保存潜在客户数据的方法:在文件中(出于备份原因)以及通过 API 直接到 Leadrock 平台。要使用 API,请指定您的 API 密钥和密钥密码(您可以在配置文件中找到它们)。

使用表单参数设置方法将表单数据存储到提供者(文件或 API),默认情况下使用 user_phoneuser_namepriceuser_emailother

预着陆集成

index.php 与您的 HTML 文件一起添加,将 HTML 模板重命名为类似 template.html 的内容,这样您就可以将 HTML 代码与 PHP 集成代码分离,以便于使用。

在 PHP 文件中,您应使用头部和尾部集成,在头部指定设置,并将您的模板文件包含在中间

<?php
include 'vendor/autoload.php';

$integration = new \Leadrock\Layouts\PreLanding();
$integration
    ->findTrackIn('track_id')
    ->setWebmasterLink('https://leadrock.com/URL-QW123-ER4567');
 
include 'template.html';
 
$integration->end();

上述代码将跟踪 ID(来自 track_id 参数)存储在 cookies 和会话中,并使用提供的网络管理员链接替换渲染给用户之前的模板中的所有链接。接下来,用户点击任何链接都将通过平台重定向到您指定的着陆页。

在未知网络管理员 URL 的情况下(多个网络管理员使用相同的着陆页或预着陆页)可以使用额外参数用于链接替换(或当在着陆页中使用时跟踪点击)

<?php
include 'vendor/autoload.php';

$integration = new \Leadrock\Layouts\PreLanding();
$integration
    ->findTrackIn('track_id')
    ->setWebmasterLinkFromParam('link');
 
include 'template.html';
 
$integration->end();

如果未设置网络管理员设置的感谢页面 URL(在优惠链接设置或其他选项中),您可以在表单提交后设置默认 URL 进行重定向

<?php
$integration->setThankyouPage('thankyou.php');

感谢页面集成

thankyou.php 与您的HTML文件一起添加,将HTML模板重命名为类似 thankyou.html 的名称,这样您就可以轻松地将HTML代码与PHP集成代码分离。

<?php
include 'vendor/autoload.php';

$integration = new \Leadrock\Layouts\ThankYou();
 
include 'thankyou.html';
 
$integration->end();

您可以在每种布局类型中使用额外的Facebook设置,见上文。

Facebook跟踪像素

您可以通过在构造函数中添加ID来添加自己的Facebook像素

<?php
$pixel2 = new \Leadrock\Items\FacebookPixel('111111111112');
$pixel3 = new \Leadrock\Items\FacebookPixel('111111111113');
$integration
    ->addFacebookPixel($pixel2)
    ->addFacebookPixel($pixel3);

多个Facebook像素可以正常工作。您还可以更改捕获参数

<?php
$pixel = (new \Leadrock\Items\FacebookPixel())->findFrom('fbpixel');
$integration->addFacebookPixel($pixel);

像素事件可以在不同页面上进行更改

<?php
$pixel = new \Leadrock\Items\FacebookPixel('111111111112');
$pixel->setEvent('Purchase');
$integration->addFacebookPixel($pixel);

除了事件价格和货币外,还可以添加

<?php
$pixel = new \Leadrock\Items\FacebookPixel('111111111112');
$pixel->setEvent('Purchase')->setPrice(10, 'USD');
$integration->addFacebookPixel($pixel);

直接链接

有两种选项可以用来使用不带跟踪重定向的直接着陆链接:在配置中使用跟踪URL或提供跟踪URL作为参数

<?php
$integration->setWebmasterLink('https://leadrock.com/URL-XY123-ZA456');

<?php
$integration->setWebmasterLinkFromParam('url');

广告商集成

如果您不需要任何基于着陆的集成,并且您正在寻找直接请求发送(例如,用于您的CRM集成),您可以将所有集成过程简化为Lead handler

<?php
$trackId = '10001.1234567890';
 
$lead = new \Leadrock\Items\Lead($trackId);
$lead->addProvider(
    new \Leadrock\Providers\Leadrock('1278g3', 'so4ircshboiuerbvs')
);
$lead->setParam('user_name', 'Han Solo');
$lead->setParam('other', 'on Millenium Falcon');
$lead->setParam('user_phone', '+1 555 0000000');
$lead->save();
 
$lead->changeStatus(Leadrock\Items\Lead::STATUS_APPROVED);
$lead->save();
 
$lead->changeStatus(Leadrock\Items\Lead::STATUS_REJECTED);
$lead->save();

帮助和文档

平台信息

LeadRock是全球领先的联盟网络,为全球的广告商和媒体合作伙伴提供顶级优惠和性能解决方案。

  • 每个国家都有本地的呼叫中心扬声器
  • 全球最佳独家优惠
  • 卓越的EPC
  • 最高的联盟佣金率