README

PHP Optimove API 客户端。

要求

PHP 7
Curl

实现的 API 调用

general/login
integrations/AddPromotions
integrations/GetPromotions
integrations/DeletePromotions

示例

<?php
use GenesisGlobal\Optimove\Client;

$username = 'foo';
$password = 'password';
$client = new Client($username, $password);


$promotions = [
  ["PromoCode" => "WB23", "PromotionName" => "Welcome back Promo"}],
  ["PromoCode" => "NV10", "PromotionName" => "New VIP 10% Discount"]
];
$client->promotions()->AddPromotions($promotions);

?>

参考

Client 对象具有返回特定 API 部分对象的函数。 Client 的可用方法

general() - 返回 general/* 调用的对象
promotions() - 返回 promotions/* 调用的对象

Client

这是主对象，其中包含您需要使用 Optimove API 的所有方法。

__construct(string $username, string $password)

Client 构造函数需要以下参数

string $username - Optimove 账户用户名
string $password - Optimove 账户密码

示例

<?php
use GenesisGlobal\Optimove\Client;

$username = 'foo';
$password = 'password';
$client = new Client($username, $password);

general() :General

方法返回 General 对象。

示例

<?php
use GenesisGlobal\Optimove\Client;

$username = 'foo';
$password = 'password';
$client = new Client($username, $password);

$general = $client->general();

promotions() :Promotions

方法返回 Promotions 对象。

示例

<?php
use GenesisGlobal\Optimove\Client;

$username = 'foo';
$password = 'password';
$client = new Client($username, $password);

$promotions = $client->promotions();

General

要获取 General 对象，您应从 Client 对象调用方法 general()。

login(string $username, string $password)

方法将 Client 登录到 Optimove API。此方法在创建 Client 实例时自动执行。

参数

string $username - Optimove 账户用户名
string $password - Optimove 账户密码

示例

<?php
use GenesisGlobal\Optimove\Client;

$username = 'foo';
$password = 'password';
$client = new Client($username, $password);

$newUser = 'bar';
$newPassword = 'secret';
$client->general()->login($newUser, $newPassword);

Promotions

要获取 Promotions 对象，您需要从 Client 对象调用方法 promotions()。

AddPromotions(array $promotions)

添加促销代码和相关名称，这些名称将在运行活动时可供选择。无需担心 Optimove 对发送促销代码的限制。

如果您在一个调用中发送超过 100 个促销代码，则该方法将分块您的数据，并使用多个 API 调用来发送您的数据。

参数

array $promotions 促销数组，每个促销都应该是一个包含以下键的数组
- PromoCode
- PromotionName

示例

<?php
use GenesisGlobal\Optimove\Client;

$username = 'foo';
$password = 'password';
$client = new Client($username, $password);

$promotions = [
  ["PromoCode" => "WB23", "PromotionName" => "Welcome back Promo"}],
  ["PromoCode" => "NV10", "PromotionName" => "New VIP 10% Discount"]
];
$client->promotions()->AddPromotions($promotions);

GetPromotions()

返回所有定义的促销代码和相关名称的数组。

参数

None

示例

<?php
use GenesisGlobal\Optimove\Client;

$username = 'foo';
$password = 'password';
$client = new Client($username, $password);

$promotions = $client->promotions()->GetPromotions();

DeletePromotions(array $promotions)

删除之前添加的促销代码。无需担心 Optimove 对发送促销代码的限制。