dotzero/yii2-amocrm

Расширение для Yii Framework 2 реализующее клиент для работы с API amoCRM

v0.2.2 2018-01-15 10:09 UTC

Requires

• php: >=5.5.0
• dotzero/amocrm: 0.3.*
• yiisoft/yii2: *

Requires (Dev)

• phpunit/phpunit: ^5.7

MIT

• dotzero

• api
• extension
• crm
• yii2
• amoCRM

README

Расширение для Yii Framework 2 реализующее клиент для работы с API amoCRM используя библиотеку для работы с API amocrm-php.

Требования:

• Yii Framework 2
• Composer

Установка

Через composer:

$ composer require dotzero/yii2-amocrm

• Добавить amocrm в секцию components конфигурационного файла:

'components' => [
    ...
    'amocrm' => [
        'class' => 'yii\amocrm\Client',
        'subdomain' => 'example', // Персональный поддомен на сайте amoCRM
        'login' => '[e-mail]', // Логин на сайте amoCRM
        'hash' => '00000000000000000000000000000000', // Хеш на сайте amoCRM

        // Для хранения ID полей можно воспользоваться хелпером
        'fields' => [
            'StatusId' => 10525225,
            'ResponsibleUserId' => 697344,
        ],
    ],
],

Пример использования:

try {
    // Получение экземпляра модели для работы с аккаунтом
    $amo = Yii::$app->amocrm->getClient();
    $account = $amo->account;

    // или прямо
    $account = Yii::$app->amocrm->account;

    // Вывод информации об аккаунте
    print_r($account->apiCurrent());

    // Получение экземпляра модели для работы с контактами
    $contact = $amo->contact;

    // Заполнение полей модели
    $contact['name'] = 'ФИО';
    $contact['request_id'] = '123456789';
    $contact['date_create'] = '-2 DAYS';
    $contact['responsible_user_id'] = $amo->fields['ResponsibleUserId'];
    $contact['company_name'] = 'ООО Тестовая компания';
    $contact['tags'] = ['тест1', 'тест2'];
    $contact->addCustomField(448, [
        ['[phone]', 'WORK'],
    ]);

    // Добавление нового контакта и получение его ID
    print_r($contact->apiAdd());

} catch (\AmoCRM\Exception $e) {
    printf('Error (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage());
}

Документация

Смотреть документацию к библиотеке amocrm-php.

Лицензия

Библиотека доступна на условиях лицензии MIT: http://www.opensource.org/licenses/mit-license.php