madnesscode/voluum

Voluum SDK for PHP

Voluum SDK For PHP

, _(*1)

This repository contains the open source PHP SDK that allows you to access the Voluum REST API, _(*2)

Installation

The Voluum PHP SDK can be installed with Composer. Run this command:, _(*3)

composer require madnesscode/voluum

Usage

Note: This version of the Voluum SDK for PHP requires PHP 5.6 or greater., _(*4)

Example, _(*5)

use MadnessCODE\Voluum;

Use voluum account email and password for credentials:, _(*6)

$email = 'test@example.com';
$password = 'test';

$client = new Voluum\Client\API(new Voluum\Auth\PasswordCredentials($email, $password));

$report_api = new Voluum\API($client);

Or use access id and key:, _(*7)

$access_key_id = "access_key_id";
$access_key = "access_key";

$client = new Voluum\Client\API(new Voluum\Auth\AccessKeyCredentials($access_key_id, $access_key));

$report_api = new Voluum\API($client);

How to get report:, _(*8)

$result = $report_api->get("report", [
   "from" => date("Y-m-d"),
   "to" => date("Y-m-d"),
   "groupBy" => "campaign"
]);

//Get result as json
echo $result->getJson();

//Get result as object
var_dump($result->getData());

Create new lander:, _(*9)

$result = $report_api->post("lander", [
   "namePostfix" => "Test",
   "url" => "http://example.com"
]);

Edit lander:, _(*10)

$result = $report_api->put("lander/xxxxx-xxxxxx-xxxxxx-xxxxx", [
   "namePostfix" => "Test 1",
   "url" => "http://example.com"
]);

Delete lander:, _(*11)

$result = $report_api->delete("lander", [
   "ids" => "xxxxx-xxxxxx-xxxxxx-xxxxxx"
]);

Upload conversion:, _(*12)

$result = $report_api->csv("conversion", 
    "POST", 
    "c384EFV6JHQODRN70575OK6,1.2,abc123,app_install");

Complete documentation is available here., _(*13)

License

Please see the license file for more information., _(*14)