pashamesh/comagic-api

php binding for CoMagic API

Uiscom & CoMagic API PHP client

CoMagic php client for: - Rest API https://www.comagic.ru/support/api/ - Call API, _(*1)

Installation

To get started, install package via the Composer package manager:, _(*2)

composer require pashamesh/comagic-api, _(*3)

Usage

Configuring

Array is using to configure Rest API and Call API clients., _(*4)

$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:, _(*5)

$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 forget to add Call API permissions to user if you want to use login and password authorization for Call API., _(*6)

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, _(*7)

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

It's possible to get response metadata after API request is made, _(*8)

var_dump($callApi->metadata());