pashamesh/comagic-api

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

php binding for CoMagic API

0.2.3 2020-04-23 16:05 UTC

Requires

• guzzlehttp/guzzle: ^6.2

Unknown License

• Pasha Mesh

README

CoMagic & Uiscom API php client

CoMagic php client for:

• Rest API https://www.comagic.ru/support/api/
• Call API

Installation

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

composer require pashamesh/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',
];

You also need to change domain if you client of Uiscom by specifying endpoint:

$config = [
    // required for Rest API and optional for Call API
    'login' => 'put_login_here',
    'password' => 'put_password_here',
    'endpoint' => [
        'rest_api' => 'https://api.uiscom.ru/api/'
    ],
    // 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());