From fb193e9e91dead91960e44b83bf9be11d89584eb Mon Sep 17 00:00:00 2001 From: Sergey Tolkachyov Date: Tue, 6 Dec 2022 07:45:53 +0400 Subject: [PATCH] Update README.md --- README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/README.md b/README.md index 6c0df37..97ad653 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,58 @@ # WT Amo CRM library for Joomla 4 A small PHP library for Joomla 4 and Amo CRM. For developers. +As part of the package +- amoCRM connection library +- settings plugin for connecting to Amo CRM System - WT Amo CRM Library +### Connecting the library to your Joomla extension +``` +use Webtolk\Amocrm\Amocrm; +$amocrm = new Amocrm(); +$result_amo_crm = $amocrm->getAccountInfo(); +``` +### Amo CRM Fields for Joomla Form +The library contains a set of Joomla Form fields with information obtained from Amo CRM. +#### Accountinfo +Outputs html with data about the Amo CRM account. Example of using Joomla 4 modules and plugins in XML manifests. +``` + +``` +#### Companiestagslist - Companies tags list  +A list of tags for companies in Amo CRM. An example of using Joomla 4 modules and plugins in XML manifests. +``` + +``` +#### Contactstagslist - Contacts tags list +A list of tags for contacts in Amo CRM. An example of using Joomla 4 modules and plugins in XML manifests. +``` + +``` +#### Leadcustomfieldslist - Lead custom fields list +A list of custom Amo CRM fields for transactions. +``` + +``` +#### Leadspipelineslist - Leads pipelines list +List of Amo CRM sales funnels. +``` + +``` +#### Leadstagslist - Leads tags list +List of tags for deals +``` + +``` +##List of library methods +- getAccountInfo +- getLeadById +- createLeads +- createLeadsComplex +- getTags +- getLeadsPiplines +- getLeadsCustomFields +- getContactsCustomFields +- getCompaniesCustomFields +- getCustomersCustomFields +- getContacts +- getUserById + +Docs in progress. Methods are described in library code (PHP Doc block)