melvin-hamilton-digital / emarsys-api
Emarsys API集成
0.1.1
2021-08-13 10:39 UTC
Requires
- php: >=7.2
- ext-json: *
- doctrine/annotations: ^1
- guzzlehttp/psr7: ^2.0
- psr/http-client: ^1.0
- symfony/serializer: ^4|^5
Requires (Dev)
- phpunit/phpunit: ^9
README
API文档
https://dev.emarsys.com/v2/emarsys-developer-hub
当前功能
- 联系管理,
- 触发外部事件,
- 字段管理,
- 产品及销售数据生成,
- 销售数据上传。
示例用法
use GuzzleHttp\Client as HttpClient; use MHD\Emarsys\Api\Authentication; use MHD\Emarsys\Api\Client as EmarsysClient; use MHD\Emarsys\Api\Contacts; use MHD\Emarsys\Api\Events; use MHD\Emarsys\Data\ContactFields; $authentication = new Authentication('username', 'secret'); $httpClient = new HttpClient(['base_uri' => EmarsysClient::BASE_URI]); $emarsysClient = new EmarsysClient($authentication, $httpClient); # create new contact $newContact = (new ContactFields()) ->setEmail('john.doe@example.org') ->setFirstName('John') ->setLastName('Doe') ->setGender(ContactFields::GENDER_MALE); $contacts = new Contacts($emarsysClient); $contacts->createContact($newContact); # send email to John $events = new Events($emarsysClient); $events->triggerEvent(1234, 'john.doe@example.org');
产品数据
Emarsys产品数据可以是Google产品数据或自定义CSV格式。虽然使用Google产品数据可能更好,因为不仅Emarsys支持,这个库仍然提供了
MHD\Emarsys\Data\ProductData类,它涵盖了所有标准产品数据字段,MHD\Emarsys\ProductFeed\CustomField注释类和MHD\Emarsys\ProductFeed\ProductDataNameConverter用于自定义产品数据字段,
这些类旨在与symfony/serializer库一起使用。
use MHD\Emarsys\Data\ProductData; use MHD\Emarsys\ProductFeed\ProductDataNameConverter; use Symfony\Component\Serializer\Encoder\CsvEncoder; use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer; use Symfony\Component\Serializer\Normalizer\PropertyNormalizer; use Symfony\Component\Serializer\Serializer; class CustomProductData extends ProductData { /** * @MHD\Emarsys\ProductFeed\CustomField */ public $customField; } $productData = new CustomProductData; $productData->item = 'foo'; $productData->customField = 'bar'; $normalizers = [ new PropertyNormalizer(null, new ProductDataNameConverter()), new DateTimeNormalizer(), ]; $serializer = new Serializer($normalizers, [new CsvEncoder()]); echo $serializer->serialize([$productData], 'csv'); # c_custom_field,item,title,link,image,zoom_image,category,available,description,price,msrp,brand # bar,foo,,,,,,,,,,
销售数据
为此库提供Emarsys销售数据生成
MHD\Emarsys\Data\SalesData类,它涵盖了标准销售数据字段集,MHD\Emarsys\SalesFeed\CustomField注释类,以及MHD\Emarsys\SalesFeed\SalesDataNameConverter用于销售数据自定义字段,MHD\Emarsys\SalesFeed\Uploader类用于自动销售数据上传。
use MHD\Emarsys\Data\SalesData; use MHD\Emarsys\SalesFeed\SalesDataNameConverter; use Symfony\Component\Serializer\Encoder\CsvEncoder; use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer; use Symfony\Component\Serializer\Normalizer\PropertyNormalizer; use Symfony\Component\Serializer\Serializer; class CustomSalesData extends SalesData { /** * @MHD\Emarsys\SalesFeed\CustomField("string") */ public $customField; } $salesData = new CustomSalesData; $salesData->item = 'foo'; $salesData->customField = 'bar'; $normalizers = [ new PropertyNormalizer(null, new SalesDataNameConverter()), new DateTimeNormalizer(), ]; $serializer = new Serializer($normalizers, [new CsvEncoder()]); echo $serializer->serialize([$salesData], 'csv'); # s_custom_field,item,price,order,timestamp,customer,email,quantity # bar,foo,,,,,,