README

This repository contains the open source PHP client for Ourvoice's REST API. Documentation can be found at: https://api-docs.getourvoice.com/

Requirements

• Sign up for a free Ourvoice account
• Create a new access_key in the developers sections
• Ourvoice API client for PHP requires PHP >= 7.4.

Installation

Composer installation

• Download composer
• Run composer require ourvoice/ourvoice-php.

Manual installation

When you do not use Composer. You can git checkout or download this repository and include the Ourvoice API client manually.

Usage

Here is a quick breakdown on how it works. First, you need to set up a Ourvoice\Client. Be sure to replace YOUR_ACCESS_KEY with something real.

$ourvoice = new \Ourvoice\Client('YOUR_API_KEY');

That's easy enough. Now we can query the server for information. Lets use getting your campaigns overview as an example:

// Get your campaigns
$myCampaigns = $ourvoice->campaigns->getList();

Documentation

Complete documentation, instructions, and examples are available at: https://api-docs.getourvoice.com/

License

The Ourvoice REST Client for PHP is licensed under The MIT License. Copyright (c) 2023, Ourvoice