snapshotpl/salesmanago-api

PHP版SalesManago API

2.4.1 2022-05-06 19:41 UTC

README

实现SalesManago API版本1.45。更多关于API的详细信息,请访问SalesManago网站

安装

通过composer安装此包。
使用最新稳定版本

php composer.phar require pixers/salesmanago-api:1.1.1

使用最新版本

php composer.phar require pixers/salesmanago-api:dev-master

用法

API客户端分为几个子服务,每个子服务负责特定的资源(例如联系人、事件)

  • ContactService
    • ContactService::create($owner, $data)
    • ContactService::update($owner, $email, $data)
    • ContactService::upsert($owner, $email, $data)
    • ContactService::delete($owner, $email, $data)
    • ContactService::has($owner, $email)
    • ContactService::useCoupon($email, $coupon)
    • ContactService::listByEmails($owner, $data)
    • ContactService::listByIds($owner, $data)
    • ContactService::listRecentlyModified($owner, $data)
    • ContactService::listRecentActivity($data)
  • CouponService
    • CouponService::create($owner, $email, $data)
  • EmailService
    • EmailService::create($data)
  • EventService
    • EventService::create($owner, $email, $data)
    • EventService::update($owner, $eventId, $data)
    • EventService::delete($owner, $eventId)
  • MailingListService
    • MailingListService::add($email)
    • MailingListService::remove($email)
  • PhoneListService
    • PhoneListService::add($email)
    • PhoneListService::remove($email)
  • RuleService
    • RuleService::create($owner, $data)
  • SystemService
    • SystemService::registerAccount($data)
    • SystemService::authorise($userName, $password)
  • TagService
    • TagService::getAll($owner, $data)
    • TagService::modify($owner, $email, $data)
  • TaskService
    • TaskService::create($data)
    • TaskService::update($taskId, $data)
    • TaskService::delete($taskId)

基本用法

<?php

use Pixers\SalesManagoAPI\Client;
use Pixers\SalesManagoAPI\SalesManago;

// First - initialize configured client
// endpoint - e.g. https://app3.salesmanago.pl/api/
$client = new Client($clientId, $endpoint, $apiSecret, $apiKey);

// Then - initialize SalesManago Services Locator
$salesManago = new SalesManago($client);

// Now you can use specific services
$contactResponse = $salesManago->getContactService()->delete($owner, $email, $data);

$eventResponse = $salesManago->getEventService()->delete($owner, $eventId);

测试

phpunit.xml文件中创建phpunit配置,基于phpunit.xml.dist模板。之后,您可以使用以下命令运行测试:

phpunit -c phpunit.xml

作者

许可证

版权所有 2016 PIXERS Ltd - www.pixersize.com

BSD 3-Clause许可下发布