atlantis-labs / beetle-eye-php-client
此包是一个库,允许您轻松地向Beetle Eye API发送请求,以便将任意数据提交到Beetle Eye。
1.0.7
2018-05-15 13:43 UTC
Requires
- php: >=5.3.0
- rmccue/requests: 1.7
README
Beetle Eye PHP客户端是一个库,允许您轻松地向Beetle Eye API发送请求,以便将任意数据提交到Beetle Eye。目前,我们允许提交表单和销售。将表单或销售存储在Beetle Eye中,将允许您了解提交情况,例如统计数据,或者/以及使用数据进行不同目的,例如群发邮件。
如何使用它?
实例化客户端并设置所需字段
首先,您需要使用composer安装\BeetleEye\Client
,并使用require_once("vendor/autoload.php");
添加您的composer依赖项。
实例化\BeetleEye\Client
时,您可以按照特定顺序传递您的API密钥和来源。
$beetle_eye = new \BeetleEye\Client("my-secret-api-key", "[SOURCE ID]");
或者,您可以在实例化后设置API密钥、来源ID并移除SSL验证。
$beetle_eye = new \BeetleEye\Client();
$beetle_eye->setApiKey("[YOUR_API_KEY_HERE]");
$beetle_eye->setSource( "[SOURCE ID]");
$beetle_eye->setCallMode(\BeetleEye\Client::CALL_MODE_PRODUCTION);
$beetle_eye->setSslVerification(FALSE);
$beetle_eye->setSaveIP(TRUE);
发送表单
之后,要发送表单,您可以编写
$beetle_eye->setFormKey("[FORM KEY]");
$beetle_eye->setSubmissionType(\BeetleEye\Client::TYPE_FORMS);
var_dump($beetle_eye->sendData(["first_name" => "Fname", "email" => 'test@test.com']));
我们在这里做的是设置要存储的表单的表单密钥,并告诉Beetle Eye客户端我们将发送一个表单。最后,我们发送两个键/值对来表示表单数据。
发送销售
要发送销售,您只需告诉客户端您将发送销售,并将您的销售数据传递给sendData
方法。
$beetle_eye->setSubmissionType(\BeetleEye\Client::TYPE_SALES);
$beetle_eye->setSaleId('123456-unique');
$sales = [
['total_cost_with_tax' => 99.99, 'cc_name' => 'VISA'],
['total_cost_with_tax' => 24.99, 'cc_name' => 'VISA'],
];
$lead = ['first_name' => 'Fname', 'last_name' => 'Lname', 'email' => 'test@test.com'];
var_dump($beetle_eye->sendData($sales, $lead));
注意,您可以从eSDL列表发送任何字段。
详细示例
因此,从零开始创建文件,您可以使用以下代码发送表单和销售
require_once("vendor/autoload.php");
$beetle_eye = new \BeetleEye\Client();
$beetle_eye->setApiKey("[YOUR_API_KEY_HERE]");
$beetle_eye->setSource( "[SOURCE ID]");
$beetle_eye->setCallMode(\BeetleEye\Client::CALL_MODE_PRODUCTION);
$beetle_eye->setFormKey("[FORM KEY]");
$beetle_eye->setSubmissionType(\BeetleEye\Client::TYPE_FORMS);
var_dump($beetle_eye->sendData(["first_name" => "Fname", "email" => 'test@test.com']));
$beetle_eye->setSubmissionType(\BeetleEye\Client::TYPE_SALES);
$beetle_eye->setSaleId('123456-unique');
$sales = [
['total_cost_with_tax' => 99.99, 'cc_name' => 'VISA'],
['total_cost_with_tax' => 24.99, 'cc_name' => 'VISA'],
];
$lead = ['first_name' => 'Fname', 'last_name' => 'Lname', 'email' => 'test@test.com'];
var_dump($beetle_eye->sendData($sales, $lead));
请注意,销售提交类型需要特定的数据结构,如果您省略了其所需的字段,将会显示给您。
您可以在需要时使用setApiKey
、setFormKey
、setSource
、setSslVerification
和setSaveIP
来使用不同设置进行请求。