Git Product home page Git Product logo

beeswax-client's Introduction

BeesWax API PHP client

Build Status Coverage Status Maintainability Scrutinizer Code Quality

Implemented features

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.

beeswax-client's People

Contributors

elegos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.