audiens / beeswax

0.1.0 2018-10-15 08:37 UTC

Requires

• php: ^7.1
• ext-curl: *
• ext-json: *

Requires (Dev)

• php-coveralls/php-coveralls: ^2.1
• phpunit/phpunit: ^7.3
• ramsey/uuid: ^3.8
• vlucas/phpdotenv: ^2.5

MIT

Published on Packagist.org on 2020-03-30 16:16 UTC

README

Implemented features

• Session login
• Segment create
• Segment read^†
• Segment's users upload^†2
• Segment's users file upload status

^† limited to search by id ^†2 limited to single file upload, no previous uploaded file

How to

Run the tests

• Copy .env.dist to .env and edit accordingly. ATTENTION: it will create, update, delete data in the sandbox environment.
• Run vendor/bin/phpunit

Use the library

First you need to create a new BeesWaxSession object:

<?php
use Audiens\BeesWax\BeesWaxSession;

$session = new BeesWaxSession($buzzKey, $email, $password);

• $buzzKey: stinger for production, stingersbx for sandbox.
• $email: the user's email
• $password: the user's password

Then you can use one of the managers (BeesWax*Manager) to access the API. For example using the segment manager:

<?php

use Audiens\BeesWax\Segment\BeesWaxSegmentManager;

$session = /**/;
$segmentManager = new BeesWaxSegmentManager($sesion);

// ...
$segmentManager->create($mySegment);

Error handling

All the exceptions generated in this library extend Audiens\BeesWax\Exception\BeesWaxGenericException.

Particular exceptions may rise, such as BeesWaxLoginException or BeesWaxResponseException, accordingly to the PHPDoc documentation.