README

用于创建潜在客户的 © Smarkio API 的加速器

使用 Composer 进行安装和用法

将以下内容添加到您的 composer.json 文件中，以获取项目的最新稳定版本

{
    "require": {
        "smarkio/smarkio-supplier-api-client": "*"
    }
}

然后，为了在您的 PHP 文件中使用此加速器，请添加以下内容

require '[COMPOSER_VENDOR_PATH]/autoload.php';

内容

• src/Smarkio/Supplier - 与 Smarkio Lead API 交互的代码。
• examples/ - 使用此加速器的示例。

开始之前

您需要获得一个 API 令牌才能使用 API。此令牌绑定到每个 Smarkio 系统用户的详细信息。

用法

发送潜在客户

$api_token = 'YOUR API TOKEN HERE';
$external_id = '1';
$campaign_external_id = '98';
$ip_address = '74.125.224.72';
$email = 'dummy@example.net';
$domain = 'mywebsite.example.net';

// create Lead with mandatory parameters
$lead = new Lead($api_token, $external_id, $campaign_external_id, $ip_address, $email, $domain);

// send the Lead
$response = $lead->send();

带有相关文件的潜在客户发送

$api_token = 'YOUR API TOKEN HERE';
$external_id = '1';
$campaign_external_id = '98';
$ip_address = '74.125.224.72';
$email = 'dummy@example.net';
$domain = 'mywebsite.example.net';

// create Lead with mandatory parameters
$lead = new Lead($api_token, $external_id, $campaign_external_id, $ip_address, $email, $domain);

//Attach some files to it
$lead->setFiles([
    'photo' => "http://example.com/image.png",
    'cc' => "http://example.com/cc.png"
]);
// send the Lead
$response = $lead->send();

带有额外字段的潜在客户发送

$api_token = 'YOUR API TOKEN HERE';
$external_id = '1';
$campaign_external_id = '98';
$ip_address = '74.125.224.72';
$email = 'dummy@example.net';
$domain = 'mywebsite.example.net';

// create Lead with mandatory parameters
$lead = new Lead($api_token, $external_id, $campaign_external_id, $ip_address, $email, $domain);

// set Lead's optional parameters
$lead->setFirstName('João');
$lead->setLastName('Silva');
$lead->setPayout('12.12');

// set Lead's extra information
$lead->addExtraField('profession', 'developer');
$lead->addExtraField('nationality', 'portuguese');

// send the Lead
$response = $lead->send();

强制创建新潜在客户

如果您想强制创建一个新的潜在客户，绕过更新现有客户的条件，请使用 setForceNewLeadCreation() 方法

$api_token = 'YOUR API TOKEN HERE';
$external_id = '1';
$campaign_external_id = '98';
$ip_address = '74.125.224.72';
$email = 'dummy@example.net';
$domain = 'mywebsite.example.net';

// create Lead with mandatory parameters
$lead = new Lead($api_token, $external_id, $campaign_external_id, $ip_address, $email, $domain);

// force new lead creation
$lead->setForceNewLeadCreation(true);

// send the Lead
$response = $lead->send();

导出潜在客户信息

如果您想在响应中接收潜在客户信息，请使用 setDumpLeadInfo() 方法

$api_token = 'YOUR API TOKEN HERE';
$external_id = '1';
$campaign_external_id = '98';
$ip_address = '74.125.224.72';
$email = 'dummy@example.net';
$domain = 'mywebsite.example.net';

// create Lead with mandatory parameters
$lead = new Lead($api_token, $external_id, $campaign_external_id, $ip_address, $email, $domain);

// dump lead info
$lead->setDumpLeadInfo();

// send the Lead
$response = $lead->send();

在这种情况下，$response 将包含一个名为 lead_info 的新字段。

自定义 API URL

欧洲 API URL（默认）

$response = $lead->send();

或

$response = $lead->send(Lead::API_BASE_URL_EU);

巴西 API URL

$response = $lead->send(Lead::API_BASE_URL_BR);

自定义 API URL

$response = $lead->send('https://api-custom-example.smark.io');

响应格式

响应是一个包含至少 'code' 和 'message' 字段的 JSON。code 200 表示潜在客户已成功集成。

{"code":"200","message":"OK","lead_id":"85177", "smkid": "1:rLJGWJLW2mNNS2qq"}

可用字段

以下潜在客户字段可用

可以通过以下方式发送额外的参数

处理标志（注意：如果潜在客户字段和同名标志都填写了，则潜在客户字段将具有优先级）