zpearl/comagic-api

There is no license information available for the latest version (0.2.4) of this package.

php binding for CoMagic API

Maintainers

Details

github.com/zpearl/comagic-api

Source

Installs: 14

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 2

0.2.4 2017-04-03 19:15 UTC

Requires

Unknown License b1323c323256b10c359c6cc9187d4b2908219908

  • Eugen Pestov <zpearl80.woop@gmail.com>

This package is auto-updated.

Last update: 2024-04-20 03:44:05 UTC

README

CoMagic php client for:

Installation

To get started, install package via the Composer package manager:

composer require zpearl/comagic-api

Usage

Configuring

Array is using to configure Rest API and Call API clients.

$config = [
    // required for Rest API and optional for Call API
    'login' => 'put_login_here',
    'password' => 'put_password_here',
    // required for Call API if login and password not specified
    'access_token' => 'put_access_token_here',
];

Do not foreget to add Call API permissions to user if you want to use login and password authorization for Call API

Rest API

use CoMagic\RestApiClient;

$restApi = new RestApiClient($config);
var_dump(
    $restApi->call(['date_from' => '2017-01-10', 'date_till' => '2017-01-13'])
);

Call API

API Methods names need to be specified in CamelCase

$callApi = new CallApiClient($config);
var_dump($callApi->listCalls());

It's possible to get response metadata after API request is made

var_dump($callApi->metadata());