Download the PHP package cl-lab/amo-middleware without Composer
On this page you can find all versions of the php package cl-lab/amo-middleware. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cl-lab/amo-middleware
More information about cl-lab/amo-middleware
Files in cl-lab/amo-middleware
Package amo-middleware
Short Description Обёртка для библиотек работающих с API AmoCRM
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package amo-middleware
Обёртка для библиотек работающих с API amoCRM
Установка
Через composer:
Использование
Для использования обёртки пропишите в файле:
use CleverLab\AmoCRM\Middleware;
$amo = new Middleware('SUBDOMAIN', 'LOGIN', 'HASH');
$result = $amo->getAccount();
Соглашения
Любая обёртка для библиотеки должна реализовывать интерфейс CleverLab\AmoCRM\Interfaces\iMiddleware
Это будет гарантировать единообразие и наличие всех необходимых методов, что позволит избежать ошшибок при изменении обёртки в клиентском коде.
При необходимости изменить поведение метода (заменить используемую им библиотеку и т.д.) не переписывать код имеющихся классов (Унаследовать класс от базового и ереопределить нужные методы).
Документация в анотация
Каждый метод обёртки, а так же методы интерфейса документированны в формате phpDoc. Так же в большинстве методов указанны ссылки на документацию по оригинальному методу API.
Документация
Параметры методов
Часть методов, например такие как: получение списка, удаление и др. Являются просто обёрткой над методами библиотеки и принимают на вход точно такие же параметры как и метод библиотеки. Подробнее узнать о передаваемых параметрах можно в документации по API AmoCRM.
Но, методы отвечающие за добавление и групповое добавление берут работу по созданию объектов на себя и принимают на вход параметры для создания этих объектов.
Рассмотрим пример добавления сделки:
За добавление одной сделки отвечает метод addLead($parameters, $debug = false).
Как же должен выглядеть массив содержащийся в $parameters? $parameters является ассациативным массивом который может содержать все те параметры, которые допустимы для данного метода https://developers.amocrm.ru/rest_api/leads_set.php но сложности начинаются на таком параметре как 'custom_fields'. Установка этого параметра в библиотеке dotzero/amocrm-php осуществляется следующим методом: ` Поэтому при передаче параметров ваш массив параметров должен выглядеть так:
`
Метод так же принимает два необязательных параметра "enum" и "subtype", при необходимости их так же можно указать:
`
При групповом добавлении передаётся список параметров.
За групповое добавление сделок отвечает метод addGroupOfLeads($dataList, $debug = false).
` При добавлении других сущностей, действуют те же принципы.
При возниконовении вопросов, смотрите метод setParameters($object, $parameters)
При добавлении сущностей типа "Воронки и этапы продаж" вы столкнётесь с параметром "statuses_fields". В dotzero/amocrm-php данный параметр устанавливается следующим методом:
` В этом случаи ваш массив должен выглядеть так:
` Метод "addStatusField" в качетве необязательного параметра может принимать уникальный идентификатор этапа воронки.
Чтобы его передать сформируйте массив параметров следующим образом:
`
Для множественного добавления воронок, так же как и в случаи со сделками, сформируйте массив параметров. Как например:
`
