通过
搜索
搜索andrey-tech / amocrm-api-php
用于与amoCRM v2 API进行交互的简单包装，支持通过oAuth 2.0协议或用户API密钥进行认证，支持AJAX请求到前端方法，请求节流，阻止同时更新一个实体，并将请求/响应日志记录到文件。
2.18.4
2024-01-15 17:38 UTC
Requires
- php: >=7.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
Requires (Dev)
- phpunit/phpunit: ^6
README
简单的PHP7+包装，用于操作REST API amoCRM v2 (版本2)，支持通过oAuth 2.0协议或用户API密钥进行认证，支持AJAX请求到前端方法，API请求节流，阻止同时更新一个实体，并将请求/响应日志记录到文件。
该库是为了满足amoCRM对公共集成的新要求而创建的
公共集成应使用oAuth 2.0认证机制，不允许使用API密钥机制。自2020年2月起的要求。
自2020年7月1日起，用户API密钥信息在amoCRM界面中不可用。
当前版本是REST API amoCRM v4 (版本4) (API请求发送到/api/v4/)。
amoCRM REST API v2 文档
amoCRM REST API v2 文档现在在amoCRM的俄语版本网站上不可用。在英文版本网站上，该文档已移至API V2 GENERAL METHODS部分。
amoCRM REST API v2 文档的HTML格式存档已移至独立的存储库。
以下列出该存档中单独的HTML文件链接
目录
- 要求
- 安装
- 认证
- 配置参数
- 操作amoCRM实体
- 锁定单个实体的同时更新
- API 请求节流
- 调试模式和日志记录
- 错误处理
- 示例
- 类 UML 图
- 作者
- 许可证
要求
- PHP >= 7.0.
- 实现标准 PSR-4 的任意自动加载类加载器。
安装
通过 composer 安装
$ composer require andrey-tech/amocrm-api-php:"^2.7"
或通过添加
"andrey-tech/amocrm-api-php": "^2.7"
到 composer.json 文件的 require 部分中。
认证
通过 OAuth 2.0 协议进行授权（当前方法）
static AmoAPI::oAuth2(string $subdomain, string $clientId, string $clientSecret, string $redirectUri, string $authCode = null) :array$subdomain- amoCRM 的子域名或完整域名；$clientId- 集成 ID；$clientSecret- 集成密钥；$redirectUri- 重定向 URI；$authCode- 授权码（临时密钥），用于交换 access token 和 refresh token。
初始认证和交换认证代码以获取访问令牌和刷新令牌
初次授权时，通过 交换授权码 authCode 获取 access token 和 refresh token，这些 token 与传递的 $clientId、$clientSecret 和 $redirectUri 一起保存在令牌存储中。
use AmoCRM\{AmoAPI, AmoAPIException}; use AmoCRM\TokenStorage\TokenStorageException; try { // Параметры авторизации по протоколу oAuth 2.0 $clientId = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'; $clientSecret = 'TFPoaG2A5hp3G3o6opCL8eC9v92Mm0fKQWEHBDwIjedCmVliT4kI3XQcjOOP1s'; $authCode = 'eee60208cc09e3ae3506d667228038345b6578a11d4862094655f630074c8c6ed87a9d804d49b5880e'; $redirectUri = 'https://www.example.com/oauth2/'; $subdomain = 'testsubdomain'; // Первичная авторизация AmoAPI::oAuth2($subdomain, $clientId, $clientSecret, $redirectUri, $authCode); // Получение информации об аккаунте вместе с пользователями и группами print_r(AmoAPI::getAccount($with = 'users,groups')); } catch (AmoAPIException $e) { printf('Ошибка авторизации (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); } catch (TokenStorageException $e) { printf('Ошибка обработки токенов (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
后续认证
初次交换授权码获取 access token 和 refresh token 后，后续授权时，只需传递 $subdomain - amoCRM 的子域名或完整域名。
use AmoCRM\{AmoAPI, AmoAPIException}; use AmoCRM\TokenStorage\TokenStorageException; try { // Последующие авторизации $subdomain = 'testsubdomain'; AmoAPI::oAuth2($subdomain); // Получение информации об аккаунте print_r(AmoAPI::getAccount()); } catch (AmoAPIException $e) { printf('Ошибка авторизации (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); } catch (TokenStorageException $e) { printf('Ошибка обработки токенов (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
当 access token 过期时，会自动获取新的 access token 和 refresh token，这发生在 API 响应 HTTP 状态码 401 Unauthorized 时。
存储access和refresh令牌
保存和加载 token 使用实现 \AmoCRM\TokenStorage\TokenStorageInterface 接口的类。
接口 TokenStorageInterface
\AmoCRM\TokenStorage\TokenStorageInterface 接口中定义了三个方法
save(array $tokens, string $domain) :void保存授权参数和 token。$tokens- 授权参数和 token 的关联数组
[ 'access_token' => '...', 'refresh_token' => '...', 'client_id' => '...', 'client_secret' => '...', 'redirect_uri=> '...' ];$domain- amoCRM 的完整域名（例如，testsubdomain.amocrm.ru）。
load(string $domain) :?array加载授权参数和 token 并返回它们。当没有保存的 token 时，方法应返回null。$domain- amoCRM 的完整域名。
hasTokens(string $domain) :bool检查是否存在指定 amoCRM 域名的 token，即是否已执行初次授权。$domain- amoCRM 的完整域名。
类 FileStorage
默认情况下，使用实现 \AmoCRM\TokenStorage\TokenStorageInterface 接口的 \AmoCRM\TokenStorage\FileStorage 类来保存和加载 token。该类将 token 存储在 JSON 文件中，文件名与 amoCRM 域名对应（例如，testsubdomain.amocrm.ru.json）。
可以通过传递给类的构造函数的参数指定存储 token 文件的目录
__construct(string $storageFolder = '')类构造函数。$storageFolder- 存储 token 文件的目录。可以是绝对路径或相对于当前工作目录的路径。如果传递空字符串，则创建默认目录 - 'tokens'。
在发生错误时抛出 \AmoCRM\TokenStorage\TokenStorageException 类的异常。
使用自定义类来存储令牌
使用自定义类将 token 保存到数据库的示例
use AmoCRM\{AmoAPI, AmoAPIException}; use AmoCRM\TokenStorage\DatabaseStorage; try { // Параметры авторизации по протоколу oAuth 2.0 $clientId = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'; $clientSecret = 'TFPoaG2A5hp3G3o6opCL8eC9v92Mm0fKQWEHBDwIjedCmVliT4kI3XQcjOOP1s'; $authCode = 'eee60208cc09e3ae3506d667228038345b6578a11d4862094655f630074c8c6ed87a9d804d49b5880e'; $redirectUri = 'https://www.example.com/oauth2/'; $subdomain = 'testsubdomain'; // Устанавливаем объект класса, обеспечивающего сохранение токенов AmoAPI::$tokenStorage = new DatabaseStorage(); // Авторизация AmoAPI::oAuth2($subdomain, $clientId, $clientSecret, $redirectUri, $authCode); // Получение информации об аккаунте print_r(AmoAPI::getAccount()); } catch (AmoAPIException $e) { printf('Ошибка авторизации (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
示例类 \AmoCRM\TokenStorage\DatabaseStorage
<?php namespace AmoCRM\TokenStorage; class DatabaseStorage implements TokenStorageInterface { /** * Сохраняет токены * @param array $tokens Токены для сохранения * @param string $domain Полный домен amoCRM * @return void */ public function save(array $tokens, string $domain) { // Здесь токены сохраняются в базе данных } /** * Загружает токены * @param string $domain Полный домен amoCRM * @return array|null */ public function load(string $domain) { // Здесь токены извлекаются из базы данных } /** * Проверяет: существуют ли токены для заданного домена amoCRM, * то есть была ли выполнена первичная авторизация * @param string $domain Полный домен amoCRM * @return boolean */ public function hasTokens(string $domain) :bool { // Здесь проверяется наличие токенов в базе данных } }
检查初始认证
为了检查是否已为 amoCRM 的指定子域名进行了初次授权，可以使用 \AmoCRM\TokenStorage\TokenStorageInterface 接口的 hasTokens() 方法。
use AmoCRM\{AmoAPI, AmoAPIException}; use AmoCRM\TokenStorage\{FileStorage, TokenStorageException}; try { // Параметры авторизации по протоколу oAuth 2.0 $clientId = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'; $clientSecret = 'TFPoaG2A5hp3G3o6opCL8eC9v92Mm0fKQWEHBDwIjedCmVliT4kI3XQcjOOP1s'; $authCode = 'eee60208cc09e3ae3506d667228038345b6578a11d4862094655f630074c8c6ed87a9d804d49b5880e'; $redirectUri = 'https://www.example.com/oauth2/'; $subdomain = 'testsubdomain'; AmoAPI::$tokenStorage = new FileStorage(); $domain = AmoAPI::getAmoDomain($subdomain); $isFirstAuth = ! AmoAPI::$tokenStorage->hasTokens($domain); if ($isFirstAuth) { // Первичная авторизация AmoAPI::oAuth2($subdomain, $clientId, $clientSecret, $redirectUri, $authCode); } else { // Последующие авторизации AmoAPI::oAuth2($subdomain); } } catch (AmoAPIException $e) { printf('Ошибка авторизации (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); } catch (TokenStorageException $e) { printf('Ошибка обработки токенов (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
通过用户 API 密钥进行授权（已过时的方法）
自2020年7月1日起，用户API密钥信息在amoCRM界面中不可用。
static AmoAPI::oauth(string $login, string $hash, string $subdomain) :array$login- 用户登录名；$hash- 用户 API 密钥；$subdomain- amoCRM 的子域名或完整域名。
以下是通过 API 密钥进行用户授权的示例。
use \AmoCRM\{AmoAPI, AmoAPIException}; try { // Параметры авторизации по API-ключу пользователя $login = 'login@example.com'; $hash = 'TFPoaG2A5hp3G3o6opCL8eC9v92Mm0fKQWEHBDwIjedCmVliT4kI3XQcjOOP1s'; $subdomain = 'testsubdomain'; // Авторизация AmoAPI::auth($login, $hash, $subdomain); // Получение информации об аккаунте print_r(AmoAPI::getAccount()); } catch (AmoAPIException $e) { printf('Ошибка авторизации (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
在多个amoCRM账户中同时认证
该库允许同时处理多个 amoCRM 子域名（账户）。为此，需要在每个子域名中依次执行授权。
use AmoCRM\{AmoAPI, AmoAPIException}; try { // Авторизация в поддомене 1 AmoAPI::oAuth2($subdomain1, $clientId1, $clientSecret1, $redirectUri1, $authCode1); // Авторизация в поддомене 2 AmoAPI::auth($login2, $hash2, $subdomain2); //... // Авторизация в поддомене N AmoAPI::oAuth2($subdomainN, $clientIdN, $clientSecretN, $redirectUriN, $authCodeN); } catch (AmoAPIException $e) { printf('Ошибка авторизации (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
配置参数
所有库设置参数都通过 AmoAPI 类的静态属性进行设置。
操作amoCRM实体
使用类-模型的方法处理 amoCRM 实体
- 模型类的方法
AmoContact- 联系人模型；AmoCompany- 公司模型；AmoLead- 销售线索模型；AmoNote- 事件（备注）模型；AmoTask- 任务模型；AmoCatalog- 列表（目录）模型；AmoCatalogElement- 列表（目录）元素模型；AmoIncomingLead- 未处理报价的抽象基类模型；AmoIncomingLeadForm- 通过添加表单添加未处理报价时的模型；AmoIncomingLeadSip- 类型为进入通话的未处理报价的模型。
- 以及额外的
AmoAPI类静态方法； - 模型对象公开属性的可访问参数。
方法和模型常量列表
模型的基本类 AmoObject
所有模型的基础抽象基类 AmoObject 包含以下公共方法
__construct(array $params = [], string $subdomain = null)创建新的模型对象并填充其内容。$params- 模型参数；$subdomain- 子域名或 amoCRM 的完整域名。如果为 null，则使用上次授权的子域名。
fillById(int|string $id, array $params = []) :AmoObject使用实体 ID 填充模型数据。$id- 实体 ID；$params- 传递给 amoCRM GET 请求的额外参数。
getParams() :array返回模型的所有参数。getCustomFields(array|int $ids) :array返回按 ID 指定的额外字段。$ids- 字段 ID 或字段 ID 数组。
getCustomFieldValueById(int $id, bool $returnFirst = true, string $returnValue = 'value')返回按 ID 指定的额外字段值。$i- 字段 ID；$returnFirst- 仅返回列表中的第一个值；$returnValue- 返回参数的名称，其值将被返回（value、enum、subtype）。
setCustomFields(array $params) :AmoObject设置额外字段值。$params- 额外字段值数组。
addTags(array|string $tags) :AmoObject添加标签。$tags- 标签或标签数组。
delTags(array|string $tags) :AmoObject删除标签。$tags- 标签或标签数组。
save(bool $returnResponse = false)在 amoCRM 中保存模型对象并返回实体 ID。$returnResponse- 返回服务器响应而不是实体 ID。
定义附加实体类型的常量
CONTACT_TYPE = 1- 联系人；LEAD_TYPE = 2- 销售线索；COMPANY_TYPE = 3- 公司；TASK_TYPE = 4- 任务；CUSTOMER_TYPE = 12- 买家。
类 AmoContact - 联系人模型
addLeads(array|int $id)通过 ID 绑定销售线索。addCustomers(array|int $id)通过 ID 绑定买家。addCompany(int $id)通过 ID 绑定公司。getPhone()返回联系人的第一个电话。getEmail()返回联系人的第一个电子邮件。
类 AmoCompany - 公司模型
addLeads(array|int $id)通过 ID 绑定销售线索。addContacts(array|int $id)通过 ID 绑定联系人。addCustomers(array|int $id)通过 ID 绑定买家。getPhone()返回公司的第一个电话。getEmail()返回公司的第一个电子邮件。
类 AmoLead - 交易模型
⚠ 对于未处理的报价，存在 特殊方法。
addContacts(array|int $id)根据联系人ID绑定联系人（每个交易最多40个联系人）。removeContacts(array|int $id)根据联系人ID解绑联系人。addCompany(int $id)根据公司ID绑定公司。removeCompany(int $id)根据公司ID解绑公司。setCatalogElements(array $catalogElements)根据列表ID设置列表元素（目录）。
类 AmoTask - 任务模型
addContact(int $id)根据ID绑定联系人。addLead(int $id)根据ID绑定交易。
类中定义的任务类型常量
CALL_TASKTYPE = 1- 电话呼叫；MEET_TASKTYPE = 2- 会议；MAIL_TASKTYPE = 3- 写信。
类 AmoNote - 事件（备注）模型
类中定义的事件类型常量
LEAD_CREATED_NOTETYPE = 1- 创建交易；CONTACT_CREATED_NOTETYPE = 2- 创建联系人；LEAD_STATUS_CHANGED_NOTETYPE = 3- 交易状态变更；COMMON_NOTETYPE = 4- 普通备注；COMPANY_CREATED_NOTETYPE = 12- 创建公司；TASK_RESULT_NOTETYPE = 13- 任务结果；SYSTEM_NOTETYPE = 25- 系统消息；SMS_IN_NOTETYPE = 102- 入站短信消息；SMS_OUT_NOTETYPE = 103- 出站短信消息。
类 AmoCatalog - 列表（目录）模型
类AmoCatalog没有自己的特定方法。
类 AmoCatalogElement - 列表（目录）元素模型
类AmoCatalogElement没有自己的特定方法。
类 AmoIncomingLead - 未解析的基本模型
处理未解析的交易与处理其他amoCRM实体的工作有显著区别。
根据官方文档
最初，未解析的数据存储在单独的存储中，是独立的实体，因此直到现在，在amoCRM接口和API中仍然存在一些特殊之处，这些特殊之处区分了未解析状态下的交易与其他状态下的交易。
⚠ 因此，以下类AmoObject的方法对未解析的交易模型不起作用
fillById();getCustomFields();getCustomFieldValueById();setCustomFields();addTags();delTags();AmoAPI::saveObjects();AmoAPI::saveObjectsWithLimit().
处理未解析申请的通用方法
未解析交易模型的抽象基类 - AmoIncomingLead 包含以下方法
fillByUid(int|string $uid, array $params = []) :AmoObject使用交易UID填充交易模型。$uid- 实体UID；$params- 传递给 amoCRM GET 请求的额外参数。
setIncomingLeadInfo(array $params) :AmoIncomingLead设置未解析交易的参数。$params- 未解析参数。
addIncomingLead(AmoLead|array $lead) :AmoIncomingLeadSip添加交易参数。$lead- 类AmoLead的对象或交易参数数组。
addIncomingContact(AmoContact|array $contact) :AmoIncomingLead添加联系人参数。$contact- 类AmoContact的对象或联系人参数数组。
addIncomingCompany(AmoCompany|array $company) :AmoIncomingLead添加公司参数。$company- 类AmoCompany的对象或公司参数数组。
save(bool $returnResponse = false)在未解析中添加新交易并返回包含交易UID的数组。$returnResponse- 返回服务器响应而不是UID。
用于批量将交易添加到amoCRM以及接受或拒绝未解析交易的静态方法位于类AmoAPI中。
类 AmoIncomingLeadForm - 当从Web表单添加时，未解析的申请模型
子类AmoIncomingLeadForm没有自己的特定方法。
类 AmoIncomingLeadSip - 当类型为传入电话时，未解析的申请模型
子类AmoIncomingLeadSip没有自己的特定方法。
加载实体的方法
类AmoAPI包含以下用于加载实体的公共静态方法
static getAll<Entities> (array $params, bool $returnResponse = false, string $subdomain = null) :\Generator加载所有类型为 <Entities> 的实体，具有过滤能力。
返回类型为 \Generator 的对象，以便后续检索实体参数。<Entities>:- 联系信息
- 公司
- 潜在客户
- 任务
- 笔记
- 目录元素
- 进来的潜在客户
$params- 过滤参数;$returnResponse- 返回 amoCRM 服务器的完整响应而不是实体参数数组;$subdomain- amoCRM 的子域名或完整域名。如果为 null，则使用上次执行的授权的子域名。
static get<Entities>(array $params, bool $returnResponse = false, string $subdomain = null) :?array
根据指定类型 <Entities> 加载实体，支持过滤和分页。
返回实体参数数组，用于填充模型或 null。<Entities>:- 联系信息
- 公司
- 潜在客户
- 任务
- 笔记
- Webhooks
- 小部件
- 进来的潜在客户
- 进来的潜在客户摘要
- 管道
- 目录
- 目录元素
$params- 过滤和分页参数;$returnResponse- 返回 amoCRM 服务器的完整响应而不是实体参数数组;$subdomain- amoCRM 的子域名或完整域名。如果为 null，则使用上次执行的授权的子域名。
批量保存实体的方法
AmoAPI 类包含静态方法，用于单个请求批量保存（添加或更新）最多 500 个不同类型的实体到单个 amoCRM 子域名。
根据官方文档
建议每次创建或修改的实体数量不超过 500，为了更优化的集成工作和避免错误，建议不超过 250。在接收到 504 错误时，建议减少请求中传输的实体数量并重新发送请求。
static saveObjects(array $amoObjects, bool $returnResponses = false, string $subdomain = null) :array
在 amoCRM 中添加或更新实体。返回实体参数数组。$amoObjects- 包含模型类对象数组（每种类型的对象不超过 500 个）：AmoContact、AmoCompany等；$returnResponses- 返回 amoCRM 服务器的响应数组而不是实体参数数组；$subdomain- amoCRM 的子域名或完整域名。如果为 null，则使用上次执行的授权的子域名。
static saveObjectsWithLimit(array $amoObjects, bool $returnResponses = false, string $subdomain = null, $limit = 250) :array
在 amoCRM 中添加或更新实体，对单个 API 请求中的实体数量有限制。返回实体参数数组。$amoObjects- 包含模型类对象的数组：AmoContact、AmoCompany等；$returnResponses- 返回 amoCRM 服务器的响应数组而不是实体参数数组；$subdomain- amoCRM 的子域名或完整域名。如果为 null，则使用上次执行的授权的子域名；$limit- 单个 API 请求中实体的最大数量。
批量删除实体方法
AmoAPI 类包含一个用于批量删除列表及其元素的静态方法
static delteObjects(array $amoObjects, bool $returnResponses = false, string $subdomain = null) :array
在 amoCRM 中删除实体。返回空的实体参数数组。$amoObjects- 包含模型类对象的数组：AmoCatalog或AmoCatalogElement；$returnResponses- 返回 amoCRM 服务器的响应数组而不是空的实体参数数组；$subdomain- amoCRM 的子域名或完整域名。如果为 null，则使用上次执行的授权的子域名。
Webhooks 方法
AmoAPI 类包含用于添加和删除 webhooks 的静态方法
static addWebhooks(array $params, bool $returnResponse = false, string $subdomain = null) :array
添加一个或多个 webhooks（最多 100 个）。params- webhook 参数或 webhook 参数数组；$returnResponse- 返回 amoCRM 服务器的响应数组而不是 webhook 参数数组；$subdomain- amoCRM 的子域名或完整域名。如果为 null，则使用上次执行的授权的子域名。
static deleteWebhooks(array $params, bool $returnResponse = false, string $subdomain = null) :array
删除一个或多个 webhooks（最多 100 个）。params- webhook 参数或 webhook 参数数组；$returnResponse- 返回 amoCRM 服务器的响应数组而不是 webhook 参数数组；$subdomain- amoCRM 的子域名或完整域名。如果为 null，则使用上次执行的授权的子域名。
未处理方法
AmoAPI 类包含以下用于处理未整理申请的静态方法
static saveIncomingObjects(AmoIncomingLeadForm|AmoIncomingLeadSip|array $amoObjects, bool $returnResponses = false, string $subdomain = null) :array
批量添加未整理申请。返回未整理申请的 UID 数组。$amoObjects- 包含模型类对象AmoIncomingLeadForm或AmoIncomingLeadSip或这些对象的数组；$returnResponses- 返回 amoCRM 服务器的响应数组而不是 UID 数组；$subdomain- amoCRM 的子域名或完整域名。如果为 null，则使用上次执行的授权的子域名。
static saveIncomingObjectsWithLimit(AmoIncomingLeadForm|AmoIncomingLeadSip|array $amoObjects, bool $returnResponses = false, string $subdomain = null, $limit = 250) :array
批量添加申请到未整理中，并对API请求中的申请数量进行限制。返回未整理的UID数组。$amoObjects- 包含模型类对象AmoIncomingLeadForm或AmoIncomingLeadSip或这些对象的数组；$returnResponses- 返回 amoCRM 服务器的响应数组而不是 UID 数组；$subdomain- amoCRM 的子域名或完整域名。如果为 null，则使用上次执行的授权的子域名；$limit- 单个API请求中的最大申请数量。
static acceptIncomingLeads(array $params, bool $returnResponse = false, $subdomain = null) :array接受未整理的申请。params- 申请参数；$returnResponse- 返回amoCRM服务器的响应，而不是接受申请的参数数组；$subdomain- amoCRM 的子域名或完整域名。如果为 null，则使用上次执行的授权的子域名。
static declineIncomingLeads(array $params, bool $returnResponse = false, $subdomain = null) :array拒绝未整理的申请。params- 申请参数；$returnResponse- 返回amoCRM服务器的响应，而不是拒绝申请的参数数组；$subdomain- amoCRM 的子域名或完整域名。如果为 null，则使用上次执行的授权的子域名。
额外方法
类AmoAPI的额外静态方法
static getAccount(string $with = '', string $subdomain = null) :array
返回amoCRM账户信息。$with- 以逗号分隔的返回账户额外参数列表，包括custom_fields- 实体额外字段；users- 用户；pipelines- 流程；groups- 用户组；note_types- 事件（备注）类型；task_types- 任务类型。
$subdomain- amoCRM 的子域名或完整域名。如果为 null，则使用上次执行的授权的子域名。
static getAccountDomain(string $subdomain = null) :array
在通过OAuth2.0协议进行认证时，返回amoCRM账户的域名信息。$subdomain- amoCRM 的子域名或完整域名。如果为 null，则使用上次执行的授权的子域名。
static getLastResponse(bool $unescapeUnicode = true) :?string
返回amoCRM服务器的最后响应（原始数据）。$unescapeUnicode- 解码服务器响应中的UTF-8 \uXXXX符号。
static request(string $query, string $type = 'GET', array $params = [], string $subdomain = null) :?array允许执行amoCRM API的RAW请求。$query- 请求URL的路径；$type- 请求方法 'GET', 'POST' 或 'AJAX'；$params- 请求参数；$subdomain- 子域名或 amoCRM 的完整域名。如果为 null，则使用上次授权的子域名。
static getAmoDomain(string $subdomain) :string
返回amoCRM的完整域名。$subdomain- amoCRM 的子域名或完整域名。
锁定单个实体的同时更新
在API amoCRM中，当在多个进程或执行流中同时更新同一实体（具有相同ID的交易、联系人、公司等）时，可能会因为更新请求中一起发送的实体updated_at值而出现错误"Last modified date is older than in database"。
为了防止出现此类错误，在save()方法中实现了防止同时更新同一实体的机制。在第一个启动的进程（执行流）更新实体完成之前，即获得API amoCRM的响应之前，其他竞争更新同一实体的进程将暂停，并每隔AmoAPI::$lockEntityTimeout秒尝试重新更新实体，最大尝试次数为AmoAPI::$lockEntityAttempts。
API 请求节流
为了防止在单个进程或执行流中超过API amoCRM的最大请求次数（每秒不超过7个请求），在库中实现了基于计算自上次发送API请求以来经过的时间的简单请求节流算法，并将进程暂停至1/AmoAPI::$throttle秒。
调试模式和日志记录
当启用调试模式AmoAPI::$debug = true时，将API amoCRM的每个请求/响应信息输出到STDOUT。
可以使用实现标准PSR-3的任意类-日志记录器，或者使用最简单的类-日志记录器AmoAPIDebugLogger来记录每个请求/响应到API amoCRM。类-日志记录器的对象设置在属性AmoAPI::$debugLogger中。日志记录独立于调试模式AmoAPI::$debug的状态。每次请求/响应API时，在类-日志记录器中调用debug()方法。
在AmoAPIDebugLogger类的构造函数中可以传入日志文件名
__construct(string $logFile = 'logs/debug.log')$logFile- 日志文件。
错误处理
当发生错误时，将抛出带有\AmoCRM\AmoAPIException对象异常。
异常类 AmoAPIException 包含以下辅助方法：
getErrors() : array返回来自 amoCRM 服务器响应的错误消息数组。getItems() : array返回来自 amoCRM 服务器响应的实体参数数组。
示例
处理联系人
use AmoCRM\{AmoAPI, AmoContact, AmoAPIException}; try { // Авторизация $subdomain = 'testsubdomain'; AmoAPI::oAuth2($subdomain); // Загрузка ВСЕХ контактов с возможностью фильтрации $generator = AmoAPI::getAllContacts([ 'query' => 'Ганс' ]); foreach ($generator as $items) { foreach ($items as $item) { print_r($item); } } // Загрузка контактов с возможностью фильтрации и постраничной выборки $items = AmoAPI::getContacts([ 'limit_rows' => 100, 'limit_offset' => 1000 ]); foreach ($items as $item) { print_r($item); } // ------------------------------------------------------------------------- // Создание нового контакта $contact1 = new AmoContact([ 'name' => 'Ганс-Дитрих Геншер', 'responsible_user_id' => 12345678 ]); // Установка дополнительных полей $contact1->setCustomFields([ '6532343' => 41, '123456' => [[ 'value' => '+79451112233', 'enum' => 'WORK' ]], '123467' => [[ 'value' => 'hans@example.com', 'enum' => 'WORK' ]] ]); // Сохранение контакта и получение его ID $contact1Id = $contact1->save(); // Обновление существующего контакта и получение ответа сервера amoCRM $contact2 = new AmoContact([ 'id' => 12300344, 'name' => 'Улоф Йоаким Пальме' ]); $contact2->first_name = 'Улоф'; $contact2->last_name = 'Пальме'; print_r($contact1->save($returnResponse = true)); // Пакетное добавление и/или обновление контактов $items = AmoAPI::saveObjects([ $contact1, $contact2 ]); foreach ($items as $item) { print_r($item); } // ------------------------------------------------------------------------- // Заполнение модели контакта по ID контакта $contact3 = new AmoContact(); $contact3->fillById(12345679); // Получение всех дополнительных полей контакта print_r($contact3->custom_fields); // Получение всех параметров контакта из модели print_r($contact3->getParams()); // Получение дополнительных полей контакта по ID полей print_r($contact3->getCustomFields([ 123456, 123467 ])); // Получение первого значения дополнительного поля контакта по ID поля print_r($contact3->getCustomFieldValueById(155114)); // Получение всех значений дополнительного поля контакта по ID поля print_r($contact3->getCustomFieldValueById(155116, $returnFirst = false)); // Получение первого ENUM дополнительного поля контакта по ID поля print_r($contact3->getCustomFieldValueById(155116, $returnFirst = true, $returnValue = 'enum')); // Получение всех ENUM дополнительного поля контакта по ID поля print_r($contact3->getCustomFieldValueById(155116, $returnFirst = false, $returnValue = 'enum')); // ------------------------------------------------------------------------- // Привязка сделок к контакту по ID сделок $contact3->addLeads([ 12380925, 12364352 ]); // Привязка покупателей к контакту по ID покупателей $contact3->addCustomers([ 1237374, 1239658 ]); // Добавление тегов к контакту $contact3->addTags([ 'сотрудник', 'стажер' ]); // Удаление тегов контакта $contact3->delTags('курьер'); // Сохранение контакта $contact3->save(); // ------------------------------------------------------------------------- $items = AmoAPI::getContacts([ 'responsible_user_id' => 12373452 ]); // Пакетная привязка сделки к контактам $contacts = []; foreach ($items as $item) { $contacts[] = (new AmoContact($item))->addLeads(12380925); } // Пакетное сохранение контактов AmoAPI::saveObjects($contacts); } catch (AmoAPIException $e) { printf('Ошибка (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
处理公司
use AmoCRM\{AmoAPI, AmoCompany, AmoAPIException}; try { // Авторизация $subdomain = 'testsubdomain'; AmoAPI::oAuth2($subdomain); // Загрузка ВСЕХ компаний с возможностью фильтрации $generator = AmoAPI::getAllCompanies([ 'query' => 'OOO', 'limit_offset' => 12000 ]); foreach ($generator as $items) { foreach ($items as $item) { print_r($item); } } // Загрузка компаний с возможностью фильтрации и постраничной выборки $items = AmoAPI::getCompanies([ 'responsible_user_id' => 12357492, 'limit_rows' => 250, 'limit_offset' => 1000 ]); foreach ($items as $item) { print_r($item); } // ------------------------------------------------------------------------- // Создание новой компании $company1 = new AmoCompany([ 'name' => 'ООО МММ', 'responsible_user_id' => 12358394, ]); // Установка дополнительных полей $company1->setCustomFields([ '2390423' => 'Город Москва', '123456' => [[ 'value' => '+79457778899', 'enum' => 'WORK' ]], '123467' => [[ 'value' => 'mmm@example.com', 'enum' => 'WORK' ]] ]); // Привязка контакта $company1->addContacts(12375435); // Привязка сделки $company1->addLeads(12349693); // Привязка покупателя $company1->addCustomers(1237374); // Добавление тега $company1->addTags('Акционер'); // Сохранение компании и получение ее ID $companyId = $company1->save(); // Обновление существующей компании и получение ответа сервера amoCRM $company2 = new AmoCompany([ 'id' => 12375435, 'created_by' => 12396034, 'name' => 'ООО Рога и Копыта', ]); $response = $company2->save($returnResponse = true); // Пакетное добавление и/или обновление компаний $items = AmoAPI::saveObjects([ $company1, $company2 ]); foreach ($items as $item) { print_r($item); } // ------------------------------------------------------------------------- // Заполнение модели компании по ID $company3 = new AmoCompany(); $company3->fillById(12375435); // Получение всех параметров компании из модели print_r($company3->getParams()); // Получение дополнительных полей компании по ID полей print_r($company3->getCustomFields([ 123456, 123467, 2390423 ])); // Получение первого значения дополнительного поля компании по ID поля print_r($company3->getCustomFieldValueById(2390423)); // Получение всех значений дополнительного поля компании по ID поля print_r($company3->getCustomFieldValueById(2390423, $returnFirst = false)); // Получение первого subtype дополнительного поля компании по ID поля print_r($company3->getCustomFieldValueById(2390423, $returnFirst = true, $returnValue = 'subtype')); // Получение первого ENUM дополнительного поля компании по ID поля print_r($company3->getCustomFieldValueById(2390423, $returnFirst = true, $returnValue = 'enum')); // ------------------------------------------------------------------------- $items = AmoAPI::getCompanies([ 'responsible_user_id' => 12358394 ]); // Пакетная привязка сделки к компаниям $companies = []; foreach ($items as $item) { $companies[] = (new AmoCompany($item))->addLeads([ 12380925 ]); } // Пакетное сохранение компаний AmoAPI::saveObjects($companies); } catch (AmoAPIException $e) { printf('Ошибка (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
处理交易
处理未解析的申请与处理交易有本质区别。对于它们，使用特殊方法。
use AmoCRM\{AmoAPI, AmoLead, AmoAPIException}; try { // Авторизация $subdomain = 'testsubdomain'; AmoAPI::oAuth2($subdomain); // Загрузка ВСЕХ сделок с возможностью фильтрации $generator = AmoAPI::getAllLeads([ 'responsible_user_id' => 12357492 ]); foreach ($generator as $items) { foreach ($items as $item) { print_r($item); } } // Загрузка сделок с возможностью фильтрации и постраничной выборки $items = AmoAPI::getLeads([ 'limit_rows' => 250, 'limit_offset' => 2000 ]); foreach ($items as $item) { print_r($item); } // ------------------------------------------------------------------------- // Создание новой сделки $lead1 = new AmoLead([ 'name' => 'Заказ № 964023', 'responsible_user_id' => 12358394, 'pipeline' => [ 'id' => 45232121 ], 'status_id' => 142, 'sale' => 15000 ]); // Установка дополнительных полей $lead1->setCustomFields([ '3434323' => 'Акционерное общество', '3434327' => [ 1121, 1122, 1123 ] ]); // Привязка контакта $lead1->addContacts(12375435); // Привязка компании $lead1->addCompany(12364643); // Установка элементов списка $lead1->setCatalogElements([ 93492 => [ 9898 => 10, 9899 => 5 ] ]); // Добавление тега $lead1->addTags('Акционер'); // Сохранение сделки и получение ее ID $leadId = $lead1->save(); // Обновление существующей компании и получение ответа сервера amoCRM $lead2 = new AmoLead([ 'id' => 123057838, 'sale' => 175000 ]); $response = $lead2->save($returnResponse = true); // Пакетное добавление и/или обновление сделок $items = AmoAPI::saveObjects([ $lead1, $lead2 ]); foreach ($items as $item) { print_r($item); } // ------------------------------------------------------------------------- // Заполнение модели сделки по ID $lead3 = new AmoLead(); $lead3->fillById(12328958); // Отвязка контакта от сделки $lead3->removeContacts(12345678); // Отвязка компании от сделки $lead3->removeCompany(12345671); // Получение параметров сделки из модели print_r($lead3->getParams()); // Получение дополнительных полей сделки по ID полей print_r($lead3->getCustomFields([ 123456, 123467, 2390423 ])); // Получение первого значения дополнительного поля сделки по ID поля print_r($lead3->getCustomFieldValueById(2390423)); // Получение всех значений дополнительного поля сделки по ID поля print_r($lead3->getCustomFieldValueById(2390423, $returnFirst = false)); // Получение всех ENUM дополнительного поля сделки по ID поля print_r($lead3->getCustomFieldValueById(2390423, $returnFirst = true, $returnValue = 'enum')); // ------------------------------------------------------------------------- $leads = AmoAPI::getLeads([ 'responsible_user_id' => 12358394 ]); // Пакетная привязка компании к сделкам $leads = []; foreach ($items as $item) { $leads[] = (new AmoLead($item))->addCompany(12380925); } // Пакетное сохранение сделок AmoAPI::saveObjects($leads); } catch (AmoAPIException $e) { printf('Ошибка (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
处理事件
use AmoCRM\{AmoAPI, AmoNote, AmoAPIException}; try { // Авторизация $subdomain = 'testsubdomain'; AmoAPI::oAuth2($subdomain); // Загрузка ВСЕХ событий, привязанных к сделкам, с возможностью фильтрации $generator = AmoAPI::getAllNotes([ 'type' => 'lead', 'note_type' => AmoNote::COMMON_NOTETYPE ]); foreach ($generator as $items) { foreach ($items as $item) { print_r($item); } } // Загрузка событий, привязанных к контактам, с возможностью фильтрации и постраничной выборки $items = AmoAPI::getLeads([ 'type' => 'contact', 'limit_rows' => 250, 'limit_offset' => 2000 ]); foreach ($items as $item) { print_r($item); } // ------------------------------------------------------------------------- // Создание нового события типа "обычное примечание", привязанного к сделке $note = new AmoNote([ 'element_id' => 12328687, 'note_type' => AmoNote::COMMON_NOTETYPE, 'element_type' => AmoNOTE::LEAD_TYPE, 'text' => 'Текст примечания к сделке' ]); // Сохранение события и получение его ID $noteId = $note->save(); // Обновление существующего события $note2 = new AmoNote([ 'id' => 12300958, 'text' => 'Обновленный текст события' ]); // Заполнение модели события по ID и изменение текста события $note3 = new AmoNote(); $note3->fillById(12347842); $note3->text = 'Новый тест события'; // Получение параметров события из модели print_r($note3->getParams()); // Пакетное сохранение событий AmoAPI::saveObjects([ $note2, $note3 ]); } catch (AmoAPIException $e) { printf('Ошибка (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
处理任务
use AmoCRM\{AmoAPI, AmoTask, AmoAPIException}; try { // Авторизация $subdomain = 'testsubdomain'; AmoAPI::oAuth2($subdomain); // Загрузка ВСЕХ задач, привязанных к сделкам, с возможностью фильтрации $generator = AmoAPI::getAllTasks([ 'type' => 'lead', 'filter' => [ 'task_type' => [ AmoTask::CALL_TASKTYPE, AmoTask::MAIL_TASKTYPE ] ] ]); foreach ($generator as $items) { foreach ($items as $item) { print_r($item); } } // Загрузка задач, с возможностью фильтрации и постраничной выборки $items = AmoAPI::getTasks([ 'responsible_user_id' => 12381202, 'limit_rows' => 100, 'limit_offset' => 800 ]); foreach ($items as $item) { print_r($item); } // ------------------------------------------------------------------------- // Создание новой задачи типа "написать письмо", привязанной к контакту $task = new AmoTask([ 'task_type' => AmoTASK::MAIL_TASKTYPE, 'element_type' => AmoTask::CONTACT_TYPE, 'element_id' => 12367433, 'text' => 'Необходимо написать письмо', 'complete_till_at' => 1508706000 ]); // Сохранение задачи и получение её ID $taskId = $task->save(); // Обновление существующей задачи $task2 = new AmoTask([ 'id' => 12311954, 'text' => 'Обновленный текст задачи' ]); // Привязка сделки к задаче по ID $task2->addLead(12389536); // Заполнение модели задачи по ID и изменение текста задачи $task3 = new AmoTask(); $task3->fillById(12327872); $task3->text = 'Новый тест события'; // Получение параметров задачи из модели print_r($task3->getParams()); // Пакетное сохранение задач AmoAPI::saveObjects([ $task2, $task3 ]); } catch (AmoAPIException $e) { printf('Ошибка (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
处理列表（目录）
use AmoCRM\{AmoAPI, AmoCatalog, AmoAPIException}; try { // Авторизация $subdomain = 'testsubdomain'; AmoAPI::oAuth2($subdomain); // Загрузка перечня списков с возможностью фильтрации $items = AmoAPI::getCatalogs(); foreach ($items as $item) { print_r($item); } // Создание нового списка $catalog = new AmoCatalog([ 'name' => 'Товары на складе' ]); // Сохранение списка и получение его ID $catalogId = $catalog->save(); // Обновление существующего списка $catalog2 = new AmoCatalog([ 'id' => 7185, 'name' => 'Не товары' ]); // Заполнение модели списка по ID и изменение названия списка $catalog3 = new AmoCatalog(); $catalog3->fillById(7187); $catalog3->name = 'Актуальные товары'; // Получение параметров списка из модели print_r($catalog3->getParams()); // Пакетное сохранение списков AmoAPI::saveObjects([ $catalog2, $catalog3 ]); // Пакетное удаление списков AmoAPI::deleteObjects([ $catalog2, $catalog3 ]); } catch (AmoAPIException $e) { printf('Ошибка (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
处理列表（目录）元素
use AmoCRM\{AmoAPI, AmoCatalogElement, AmoAPIException}; try { // Авторизация $subdomain = 'testsubdomain'; AmoAPI::oAuth2($subdomain); // Загрузка ВСЕХ элементов заданного списка с возможностью фильтрации $generator = AmoAPI::getAllCatalogElements([ 'catalog_id' => 4422, 'term' => 'Маркер' ]); foreach ($generator as $items) { foreach ($items as $item) { print_r($item); } } // Загрузка элементов заданного списка с фильтрацией с постраничной выборкой $items = AmoAPI::getCatalogElements([ 'catalog_id' => 4422, 'term' => 'Фломастер', 'page' => 21 ]); foreach ($items as $item) { print_r($item); } // ------------------------------------------------------------------------- // Создание нового элемента каталога $element = new AmoCatalogElement([ 'catalog_id' => 4422, 'name' => 'Ручка гелевая' ]); // Установка дополнительных полей $element->setCustomFields([ '20423' => 'Артикул 14567323', '24233' => 120 ]); // Сохранение элемента списка и получение его ID $elementId = $element->save(); // Обновление существующего элемента списка $element2 = new AmoCatalogElement([ 'id' => 12312312, 'text' => 'Ручка перьевая' ]); // Заполнение модели элемента списка по ID и изменение имени элемента $element3 = new AmoCatalogElement(); $element3->fillById(12398096); $element3->name = 'Карандаш'; // Получение параметров элемента списка из модели print_r($element3->getParams()); // Пакетное сохранение элементов AmoAPI::saveObjects([ $element2, $element3 ]); // Пакетное удаление элементов AmoAPI::deleteObjects([ $element2, $element3 ]); } catch (AmoAPIException $e) { printf('Ошибка (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
处理 webhooks
use AmoCRM\{AmoAPI, AmoAPIException}; try { // Авторизация $subdomain = 'subdomain'; AmoAPI::oAuth2($subdomain); // Получаем список установленных webhooks $webhooks = AmoAPI::getWebhooks(); print_r($webhooks); // Добавляем webhook AmoAPI::addWebhooks([ 'url' => 'https://example.com/webhook/', 'events' => [ 'add_lead' ] ]); // Удаляем webhook AmoAPI::deleteWebhooks([ 'url' => 'https://example.com/webhook/', 'events' => [ 'add_lead' ] ]); // Добавляем несколько webhooks AmoAPI::addWebhooks([ [ 'url' => 'https://example1.com/webhook/', 'events' => [ 'add_lead' ] ], [ 'url' => 'https://example2.com/webhook/', 'events' => [ 'update_lead' ] ] ]); // Удаляем несколько webhooks AmoAPI::deleteWebhooks([ [ 'url' => 'https://example1.com/webhook/', 'events' => [ 'add_lead' ] ], [ 'url' => 'https://example2.com/webhook/', 'events' => [ 'update_lead' ] ] ]); } catch (AmoAPIException $e) { printf('Ошибка (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
处理未处理中的申请
处理未解析的交易与处理其他amoCRM实体的工作有显著区别。
根据官方文档
最初，未解析的数据存储在单独的存储中，是独立的实体，因此直到现在，在amoCRM接口和API中仍然存在一些特殊之处，这些特殊之处区分了未解析状态下的交易与其他状态下的交易。
以下是在从网页表单添加时处理未解析申请的示例。
use AmoCRM\{AmoAPI, AmoLead, AmoContact, AmoIncomingLeadForm, AmoAPIException}; try { // Авторизация $subdomain = 'testsubdomain'; AmoAPI::oAuth2($subdomain); // Создаем новую заявку в неразобранном при добавлении из веб-формы $incomingLead = new AmoIncomingLeadForm(); // Устанавливаем обязательные параметры $incomingLead->setIncomingLeadInfo([ 'form_id' => 1, 'form_page' => 'https://www.example.com', 'form_name' => 'Home page form' ]); // Добавляем параметры сделки $lead = new AmoLead([ 'name' => 'Новая заявка с сайта' ]); $lead->setCustomFields([ 25475362 => '#1543252' ]); $incomingLead->addIncomingLead($lead); // Добавляем параметры контакта $contact = new AmoContact([ 'name' => 'Ганс-Дитрих Геншер' ]); $contact->setCustomFields([ 255114 => [[ 'value' => '+10349654820', 'enum' => 'WORK' ]], 255116 => [[ 'value' => 'hans@example.com', 'enum' => 'WORK' ]] ]); $incomingLead->addIncomingContact($contact); // Добавляем параметры компании $incomingLead->addIncomingCompany([ 'name' => 'Freie Demokratische Partei' ]); // Сохраняем заявку AmoAPI::saveIncomingObjects($incomingLead); // ------------------------------------------------------------------------ // Получаем заявку из неразобранного по UID $uid = 'f03c796fb5455667e648dd0ec9755fc9680bc3775ac76a540753d249d455'; $incomingLead2 = new AmoIncomingLeadForm(); $incomingLead2->fillByUid($uid); print_r($incomingLead2->getParams()); // Загрузка ВСЕХ заявок из неразобранного с фильтрацией по категории $generator = AmoAPI::getAllIncomingLeads([ 'categories' => [ 'forms' ] ]); foreach ($generator as $items) { foreach ($items as $item) { print_r($item); } } // ------------------------------------------------------------------------ // Принимаем заявки из неразобранного AmoAPI::acceptIncomingLeads([ 'accept' => [ 'f03c796fb5455667e648dd0ec9755fc9680bc3775ac76a540753d249d455', 'a12c723fb54556676e6487d0e89795fc9080bc3975ac86a548752302d478', ], 'user_id' => 13752426, 'status_id' => 142 ]); // Отклоняем заявки из неразобранного AmoAPI::declineIncomingLeads([ 'decline' => [ 'e21c796dfb5sd566de648ccb80ec546a4d25e4baecbd343actf0b3ed4363c4' ], 'user_id' => 13752426 ]); } catch (AmoAPIException $e) { printf('Ошибка (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
支持 AJAX 请求到前端方法
方法 \AmoCRM\AmoAPI::request() 允许执行针对前端方法的 AJAX 请求。
use AmoCRM\{AmoAPI, AmoAPIException}; try { // Авторизация $subdomain = 'testsubdomain'; AmoAPI::oAuth2($subdomain); $params = [ 'filter' => [ 'cf'=> [ '681165'=> [ 'from' => '30.03.2022', 'to' => '30.03.2022' ] ], ], 'useFilter' => 'y', 'element_type' => 1, 'json' => 1, 'page' => 1 ]; $data = AmoAPI::request('/ajax/contacts/list', 'AJAX', $params); print_r($data); } catch (AmoAPIException $e) { printf('Ошибка (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
示例响应（片段）
{
"response": {
"url": "\/contacts\/list\/contacts\/",
"items": [
{
"id": 68207643,
"tags": {
"items": []
},
"url": "\/contacts\/detail\/68207643",
"element_type": 1,
"entity": "contact",
"is_deleted": false,
"rights": {
"contacts": {
"edit": true
},
"companies": {
"edit": true
}
},
"class_name": "",
"name": {
"text": "Звонок от 79521111111",
"url": "\/contacts\/detail\/68207643"
},
"company_name": {
"name": "",
"url": "#"
},
"manager": "Иван Петров",
"date_create": "Сегодня 11:30",
"creator": "Робот",
"date_modified": "Сегодня 11:31",
"modified_by": "Робот",
"date_of_nearest_task": {
"date": 1652641199,
"failed": false
},
"custom_fields": [
{
"id": "72797",
"name": "Телефон",
"values": [
{
"enum": "112761",
"value": "+7 952 111-11-11"
}
]
}
],
...
处理多个子域名
use AmoCRM\{AmoAPI, AmoCompany, AmoAPIException}; try { // Авторизация в поддомене 1 // ... AmoAPI::oAuth2($subdomain1, $clientId1, $clientSecret1, $redirectUri1, $authCode1); // Авторизация в поддомене 2 // ... AmoAPI::oAuth2($subdomain2, $clientId2, $clientSecret2, $redirectUri2, $authCode2); // Загрузка компаний из поддомена 1 $items1 = AmoAPI::getCompanies([ 'responsible_user_id' => 12357492 ], $subdomain1); // Загрузка всех компаний из поддомена 2 $generator2 = AmoAPI::getAllCompanies([ 'query' => 'OOO' ], $subdomain2); // Создание новой компании для поддомена 1 $company1 = new AmoCompany([ 'name' => 'ООО Абракадабра', ], $subdomain1); // Обновление существующей компании для поддомена 1 $company2 = new AmoCompany([], $subdomain1); $company2->fillById(12389423); $company2->name = 'OOO Розенталь'; // Пакетное сохранение компаний для поддомена 1 AmoAPI::saveObjects([ $company1, $company2 ], $subomain1); } catch (AmoAPIException $e) { printf('Ошибка (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
调试和日志记录
use AmoCRM\{AmoAPI, AmoAPIDebugLogger, AmoAPIException}; try { // Включение вывода запросов/ответов к API в STDOUT AmoAPI::$debug = true; // Включение логирования запросов/ответов к API в файл AmoAPI::$debugLogger = new AmoAPIDebugLogger($logFile = 'logs/debug_amocrm_api.log'); // Авторизация $subdomain = 'testsubdomain'; AmoAPI::oAuth2($subdomain); } catch (AmoAPIException $e) { printf('Ошибка (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
类 UML 图
作者
© 2019-2021 andrey-tech
许可证
本库根据MIT 许可证进行分发。