oleg-chulakov-studio / amocrm
Wrapper for working with AmoCRM RESTfull API v2
Requires
- php: >=5.6.0
- guzzlehttp/guzzle: ~6.0
README
Обертка реализует работу с основными сущностями AmoCRM через ее API. Реализация для сущности AmoCRM будет добавляться по мере возможного.
Установка
Установка производится через Composer, путем ручного добавления пакета в composer.json
"require": {
...
"oleg-chulakov-studio/amocrm": "~1.0"
...
}
или с помощью консольной команды
composer require oleg-chulakov-studio/amocrm
Использование
Основные классы
Для успешного взаимодействия с RESTful API AmoCRM понадобится три основных "объекта" системы:
1. Аутентификатор
Реализует логику подготовки параметров авторизации для каждого запроса к API AmoCRM.
Все классы аутентификаторов реализуют интерфейс \Chulakov\AmoCRM\AuthInterface.
Базовая реализация представлена классом \Chulakov\AmoCRM\Auth\BasicAuth,
который готовит параметры для авторизации, пробрасываемые при каждом запросе.
2. Абстракция клиента HTTP(S) взаимодействия
Все классы HTTP-клиентов должны реализовывать интерфейс \Chulakov\AmoCRM\ClientInterface.
Умолчательная реализация клиента представлена классом \Chulakov\AmoCRM\Client\DefaultClient.
Объект этого класса совержает запросы к RESTfull API AmoCRM через спец. методы-оберткы
и возвращает результат в json или генерирует исключение типа \GuzzleHttp\Exception\RequestException
3. Сущности AmoCRM
Классы-сущностей AmoCRM реализуют основные методы по работе с этими сущностями.
Например, получение списков, создание, редактивроание и удаление.
Все классы сущностей AmoCRM должны наследоваться от абстрактоного класса \Chulakov\AmoCRM\Entity\BaseEntity.
Реализации сущностей будут постоянно добавляться и обновляться по мере возможности.
Примеры использования
Comming soon...