pixers/salesmanago-api

SalesManago API

1.1.2 2016-08-17 04:58 UTC

This package is not auto-updated.

Last update: 2021-01-08 22:18:36 UTC


README

Implementation of SalesManago API version 1.45. For more details about the API go to SalesManago site.

Installation

Install the package through composer.
For the latest stable version use:

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

For the latest version use:

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

Usage

API Client is divided into several sub-services, responsible for particular resources (e.g. Contacts, Events):

  • 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)

Basic usage

<?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);

Tests

Create phpunit configuration in phpunit.xml file, based on template from phpunit.xml.dist. After that you can run tests with:

phpunit -c phpunit.xml

Authors

License

Copyright 2016 PIXERS Ltd - www.pixersize.com

Licensed under the BSD 3-Clause