ourvoice/ourvoice-php

Ourvoice Api REST API client for php

Maintainers

Details

github.com/OurvoiceService/ourvoice-php

Source

Issues

Installs: 18

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

v1.0.2 2023-09-14 18:33 UTC

Requires

  • php: >=7.4
  • ext-curl: *

Requires (Dev)

MIT 78b5f5eed365b934f1b81e65cf23f17be905bd94

  • Ourvoice

This package is auto-updated.

Last update: 2024-04-14 20:01:40 UTC

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

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