[{"data":1,"prerenderedAt":449},["ShallowReactive",2],{"navigation_docs":3,"-modules-insync-api":238,"-modules-insync-api-surround":446},[4,45,60],{"title":5,"description":6,"icon":7,"path":8,"stem":9,"children":10},"Методология",null,"ruler","\u002Fmethodology","1.methodology",[11,15,20,25,30,35,40],{"title":12,"path":8,"stem":13,"description":14},"bxshef: методология и проверка навыков","1.methodology\u002Findex","Как писать навыки ИИ-агентов для Битрикса и как проверять, что им можно верить",{"title":16,"path":17,"stem":18,"description":19},"Стандарт навыка","\u002Fmethodology\u002Fstandard","1.methodology\u002F1.standard","11 правил, каждое из провала на стенде",{"title":21,"path":22,"stem":23,"description":24},"Методология проверки","\u002Fmethodology\u002Fmethod","1.methodology\u002F2.method","lint → eval → стенд; что измерено",{"title":26,"path":27,"stem":28,"description":29},"bxshef — CLI","\u002Fmethodology\u002Fbxshef","1.methodology\u002F3.bxshef","lint, eval, feedback",{"title":31,"path":32,"stem":33,"description":34},"GitHub Action","\u002Fmethodology\u002Faction","1.methodology\u002F4.action","тот же lint + eval в любом репозитории навыков",{"title":36,"path":37,"stem":38,"description":39},"Заготовка репозитория","\u002Fmethodology\u002Ftemplate","1.methodology\u002F5.template","с чего начать автору модуля",{"title":41,"path":42,"stem":43,"description":44},"Приёмник отзывов","\u002Fmethodology\u002Ffeedback","1.methodology\u002F6.feedback","куда уходят отзывы ИИ-агентов",{"title":46,"description":6,"icon":47,"path":48,"stem":49,"children":50},"Навыки","sparkles","\u002Fskills","2.skills",[51,55],{"title":52,"path":48,"stem":53,"description":54},"Навыки shef.*","2.skills\u002Findex","npx skills add bx-shef\u002Fskills",{"title":56,"path":57,"stem":58,"description":59},"shef-feedback","\u002Fskills\u002Fshef-feedback","2.skills\u002F1.shef-feedback","Отправить отзыв о навыке shef-* или навыке команды. Брать ВСЕГДА, когда просят оставить или отправить отзыв о навыке — даже если сам навык в диалоге не виден, —",{"title":61,"description":6,"icon":62,"path":63,"stem":64,"children":65},"Модули shef.*","package","\u002Fmodules","3.modules",[66,69,131,179],{"title":61,"path":63,"stem":67,"description":68},"3.modules\u002Findex","Что за чем ставить",{"title":70,"description":6,"path":71,"stem":72,"children":73},"shef.options","\u002Fmodules\u002Foptions","3.modules\u002F1.options\u002Findex",[74,76,81,86,91,96,101,106,110,114,119,123,127],{"title":70,"path":71,"stem":72,"description":75},"фундамент: настройки, трейты, компоненты",{"title":77,"path":78,"stem":79,"description":80},"[`\\Shef\\Options\\Installator`] Installer","\u002Fmodules\u002Foptions\u002Finstaller","3.modules\u002F1.options\u002F1.installer","Для облегчения установок.",{"title":82,"path":83,"stem":84,"description":85},"Сборка, CI и релиз","\u002Fmodules\u002Foptions\u002Fbuild-and-install","3.modules\u002F1.options\u002F10.build-and-install","Раскладка репозитория — в module-structure.md, процесс —\nв CONTRIBUTING.md, установка глазами пользователя —\nв README.md.",{"title":87,"path":88,"stem":89,"description":90},"Раскладка репозитория","\u002Fmodules\u002Foptions\u002Fmodule-structure","3.modules\u002F1.options\u002F11.module-structure","Файл про устройство репозитория. Опорные точки модуля — в CLAUDE.md,\nпроцесс — в CONTRIBUTING.md, сборка — в\nbuild-and-install.md.",{"title":92,"path":93,"stem":94,"description":95},"Проверка на портале","\u002Fmodules\u002Foptions\u002Fportal-check","3.modules\u002F1.options\u002F12.portal-check","Всё, что ниже рантайма Битрикса, тестами не закрыть: установка, права, кеш,\nраскладка файлов, поведение при обновлении. Проверять это приходится руками —\nи лучше по списку, потому что забытый шаг находит не разработчик, а клиент.",{"title":97,"path":98,"stem":99,"description":100},"[`\\Shef\\Options\\Main\\Options`] Опции настроек модуля","\u002Fmodules\u002Foptions\u002Foptions","3.modules\u002F1.options\u002F2.options","Поддерживает следующие типы:",{"title":102,"path":103,"stem":104,"description":105},"Работа с пользователями","\u002Fmodules\u002Foptions\u002Fsecurity","3.modules\u002F1.options\u002F3.security","",{"title":107,"path":108,"stem":109,"description":105},"[`\\Shef\\Options\\Main\\Utils`] Утилиты","\u002Fmodules\u002Foptions\u002Futils","3.modules\u002F1.options\u002F4.utils",{"title":111,"path":112,"stem":113,"description":105},"[`\\Shef\\Options\\Components`] Работа с компонентами","\u002Fmodules\u002Foptions\u002Fcomponents","3.modules\u002F1.options\u002F5.components",{"title":115,"path":116,"stem":117,"description":118},"[`\\Shef\\Options\\Options`] Паттерны","\u002Fmodules\u002Foptions\u002Fpattern","3.modules\u002F1.options\u002F6.pattern","Запускаемые примеры: singleton.php,\nconfig.php, smartstd.php —\nкак их гонять, написано в examples\u002FREADME.md.",{"title":120,"path":121,"stem":122,"description":105},"[`\\Shef\\Options\\Tests`] Тестирование","\u002Fmodules\u002Foptions\u002Ftests","3.modules\u002F1.options\u002F7.tests",{"title":124,"path":125,"stem":126,"description":105},"[`\\Shef\\Options\\TraitList`] Набор трейтов","\u002Fmodules\u002Foptions\u002Ftraitlist","3.modules\u002F1.options\u002F8.traitlist",{"title":128,"path":129,"stem":130,"description":105},"Правила для ИИ-агентов в этом репозитории","\u002Fmodules\u002Foptions\u002Fagent-rules","3.modules\u002F1.options\u002F9.agent-rules",{"title":132,"description":6,"path":133,"stem":134,"children":135},"shef.problems","\u002Fmodules\u002Fproblems","3.modules\u002F2.problems\u002Findex",[136,138,143,147,152,157,161,166,169,172,175],{"title":132,"path":133,"stem":134,"description":137},"логи, журнал событий, учёт проблем",{"title":139,"path":140,"stem":141,"description":142},"[`\\Shef\\Problems\\Integration`] События и меню","\u002Fmodules\u002Fproblems\u002Fevents","3.modules\u002F2.problems\u002F1.events","Что модуль регистрирует в ядре при установке. Список — в .settings.php, ключ\ninstallEvents; что каждый обработчик существует, сверяет\ntests\u002Fsettings_test.php.",{"title":144,"path":145,"stem":146,"description":105},"Безопасность логов","\u002Fmodules\u002Fproblems\u002Fsecurity","3.modules\u002F2.problems\u002F10.security",{"title":148,"path":149,"stem":150,"description":151},"Быстрая отладка: `_pr`, `_log`, `_log1`","\u002Fmodules\u002Fproblems\u002Fdeffunctions","3.modules\u002F2.problems\u002F2.deffunctions","Функции объявляет def-functions.php, подключается он из include.php.",{"title":153,"path":154,"stem":155,"description":156},"Уровни логирования","\u002Fmodules\u002Fproblems\u002Floglevel","3.modules\u002F2.problems\u002F3.loglevel","Уровни — стандарт PSR-3, в Monolog это \\Monolog\\Level. Ниже — когда какой брать.",{"title":158,"path":159,"stem":160,"description":105},"[`\\Shef\\Problems\\Integration\\Monolog`] Monolog","\u002Fmodules\u002Fproblems\u002Fmonolog","3.modules\u002F2.problems\u002F4.monolog",{"title":162,"path":163,"stem":164,"description":165},"Ротация логов","\u002Fmodules\u002Fproblems\u002Flogrotate","3.modules\u002F2.problems\u002F5.logrotate","Логи модуля лежат в каталоге логов — по умолчанию на уровень выше корня сайта,\nдля BitrixVM \u002Fhome\u002Fbitrix\u002Fsh_log\u002F*.log, — и сами не чистятся. Ротацию делает\nlogrotate — системная утилита, а не Monolog: Monolog тоже умеет\n(RotatingFileHandler), но тогда за файлами следит каждый PHP-процесс, а не\nодна служба.",{"title":128,"path":167,"stem":168,"description":105},"\u002Fmodules\u002Fproblems\u002Fagent-rules","3.modules\u002F2.problems\u002F6.agent-rules",{"title":82,"path":170,"stem":171,"description":85},"\u002Fmodules\u002Fproblems\u002Fbuild-and-install","3.modules\u002F2.problems\u002F7.build-and-install",{"title":87,"path":173,"stem":174,"description":90},"\u002Fmodules\u002Fproblems\u002Fmodule-structure","3.modules\u002F2.problems\u002F8.module-structure",{"title":92,"path":176,"stem":177,"description":178},"\u002Fmodules\u002Fproblems\u002Fportal-check","3.modules\u002F2.problems\u002F9.portal-check","Всё, что ниже рантайма Битрикса, тестами не закрыть: установка, права, меню,\nраскладка файлов, журнал событий, поведение при обновлении. Проверять это\nприходится руками — и лучше по списку, потому что забытый шаг находит не\nразработчик, а клиент.",{"title":180,"description":6,"path":181,"stem":182,"children":183},"shef.insync","\u002Fmodules\u002Finsync","3.modules\u002F3.insync\u002Findex",[184,186,191,194,198,203,208,213,218,222,227,232,235],{"title":180,"path":181,"stem":182,"description":185},"агенты, импорт, API-клиенты, модели",{"title":187,"path":188,"stem":189,"description":190},"[`\\Shef\\InSync\\Agents`] Агенты","\u002Fmodules\u002Finsync\u002Fagents","3.modules\u002F3.insync\u002F1.agents","Агент импорта — наследник \\Shef\\InSync\\Agents\\AAgent. Описание агента для\nb_agent — \\Shef\\InSync\\Agents\\Entity, установку и управление берёт на себя\n\\Shef\\InSync\\Agents\\Manager.",{"title":87,"path":192,"stem":193,"description":90},"\u002Fmodules\u002Finsync\u002Fmodule-structure","3.modules\u002F3.insync\u002F10.module-structure",{"title":92,"path":195,"stem":196,"description":197},"\u002Fmodules\u002Finsync\u002Fportal-check","3.modules\u002F3.insync\u002F11.portal-check","Всё, что ниже рантайма Битрикса, тестами не закрыть: установка, права, левое\nменю, раскладка компонентов, агенты, таблица импорта, поведение при\nобновлении. Проверять это приходится руками — и лучше по списку, потому что\nзабытый шаг находит не разработчик, а клиент.",{"title":199,"path":200,"stem":201,"description":202},"Безопасность","\u002Fmodules\u002Finsync\u002Fsecurity","3.modules\u002F3.insync\u002F12.security","Модуль даёт другим модулям заготовки для синхронизаций, и самые опасные места\nу него общие с ними: кто может запускать агенты и импорт, что ложится в каталоги\nимпорта, что уходит в SQL и в лог. Ниже — что держит модуль и что остаётся\nпроекту.",{"title":204,"path":205,"stem":206,"description":207},"[`\\Shef\\InSync\\Sync`] Импорт","\u002Fmodules\u002Finsync\u002Fimport","3.modules\u002F3.insync\u002F2.import","Импорт идёт в два шага через таблицу импорта \\Shef\\InSync\\Sync\\Model\\SyncTable\n(shef_insync_model):",{"title":209,"path":210,"stem":211,"description":212},"[`\\Shef\\InSync\\Api`] API","\u002Fmodules\u002Finsync\u002Fapi","3.modules\u002F3.insync\u002F3.api","Обращение к внешнему API по HTTP — наследник \\Shef\\InSync\\Api\\AConnector.",{"title":214,"path":215,"stem":216,"description":217},"[`\\Shef\\InSync\\TraitList\\Xml`] Парсинг XML","\u002Fmodules\u002Finsync\u002Fxml","3.modules\u002F3.insync\u002F4.xml","Разбор XML сделан через SbWereWolf\u002Fxml-navigator\n(статья на Хабре): XMLReader идёт по\nдокументу потоком, а каждый элемент с нужным тегом HierarchyComposer\nпревращает в массив — n имя, v значение, a атрибуты, s вложенные\nэлементы.",{"title":219,"path":220,"stem":221,"description":105},"Компоненты","\u002Fmodules\u002Finsync\u002Fcomponents","3.modules\u002F3.insync\u002F5.components",{"title":223,"path":224,"stem":225,"description":226},"Страницы","\u002Fmodules\u002Finsync\u002Fpage","3.modules\u002F3.insync\u002F6.page","Страницы модуля — в левом меню, штатным разделом intranet\n(Bitrix\\Intranet\\CustomSection): раздел «SH Импорт», код shinsync.\nВерхней панели и shef.uiclear больше нет.",{"title":228,"path":229,"stem":230,"description":231},"[`\\Shef\\InSync\\Main\\Options`] Опции настроек модуля","\u002Fmodules\u002Finsync\u002Foptions","3.modules\u002F3.insync\u002F7.options","Опции для страницы настроек модуля импорта (на ShOptionsConfig из\nshef.options): добавьте их во вкладку своего options_conf.php.",{"title":128,"path":233,"stem":234,"description":105},"\u002Fmodules\u002Finsync\u002Fagent-rules","3.modules\u002F3.insync\u002F8.agent-rules",{"title":82,"path":236,"stem":237,"description":85},"\u002Fmodules\u002Finsync\u002Fbuild-and-install","3.modules\u002F3.insync\u002F9.build-and-install",{"id":239,"title":209,"body":240,"description":212,"extension":440,"meta":441,"navigation":442,"path":210,"rawbody":443,"seo":444,"stem":211,"__hash__":445},"docs\u002F3.modules\u002F3.insync\u002F3.api.md",{"type":241,"value":242,"toc":437},"minimark",[243,252,268,308,311,341,370,410,413,425],[244,245,246,247,251],"p",{},"Обращение к внешнему API по HTTP — наследник ",[248,249,250],"code",{},"\\Shef\\InSync\\Api\\AConnector",".",[253,254,255],"blockquote",{},[244,256,257,258],{},"Пример смотреть в модуле ",[259,260,261],"strong",{},[262,263,267],"a",{"href":264,"rel":265},"https:\u002F\u002Fmarketplace.1c-bitrix.ru\u002Fsolutions\u002Fshef.demosync\u002F",[266],"nofollow","shef.demosync",[269,270,271,284],"table",{},[272,273,274],"thead",{},[275,276,277,281],"tr",{},[278,279,280],"th",{},"класс",[278,282,283],{},"что делает",[285,286,287,300],"tbody",{},[275,288,289,293],{},[290,291,292],"td",{},"AConnector",[290,294,295,296,299],{},"запрос через ",[248,297,298],{},"HttpClient"," ядра, разбор ответа, логирование ошибок в shef.problems",[275,301,302,305],{},[290,303,304],{},"Headers",[290,306,307],{},"маска секретных заголовков для лога",[244,309,310],{},"Что пишете вы:",[312,313,314,321,327],"ul",{},[315,316,317,320],"li",{},[248,318,319],{},"getPath()"," — адрес по имени функции API;",[315,322,323,326],{},[248,324,325],{},"getModuleId()"," — модуль, от имени которого пишутся проблемы;",[315,328,329,330,333,334,333,337,340],{},"при необходимости ",[248,331,332],{},"processSuccess()",", ",[248,335,336],{},"processError()",[248,338,339],{},"processError50x()"," —\nразбор ответа. Помните, что 200 — ещё не успех бизнес-логики.",[244,342,343,346,347,350,351,354,355,358,359,362,363,366,367,369],{},[248,344,345],{},"\\Shef\\InSync\\Api\\AConnector::sendRequest()"," отправляет запрос (",[248,348,349],{},"GET"," —\nпараметры в адрес, остальные методы — телом) и возвращает ",[248,352,353],{},"Result"," с\nотправленным и полученным. Таймауты — из опций объекта: ",[248,356,357],{},"socketTimeout"," (30),\n",[248,360,361],{},"streamTimeout"," (60), ",[248,364,365],{},"waitResponse"," (да). Значения приводятся к типам ядра: секунды — целым, ",[248,368,365],{}," — флагом.",[244,371,372,373,333,376,333,379,382,383,333,386,333,389,333,392,333,395,333,398,401,402,405,406,409],{},"При ошибке запрос пишется в лог проблем. Заголовки с ",[248,374,375],{},"auth",[248,377,378],{},"token",[248,380,381],{},"key",",\n",[248,384,385],{},"secret",[248,387,388],{},"pass",[248,390,391],{},"cookie",[248,393,394],{},"session",[248,396,397],{},"sign",[248,399,400],{},"access"," в имени уходят туда маской\n(",[248,403,404],{},"\\Shef\\InSync\\Api\\Headers::mask()","); параметры — как есть, секреты в них не\nкладите. Ответ не 200 без ошибок соединения даёт ошибку ",[248,407,408],{},"status: \u003Cкод>",", а не\nпустую строку, как до 2.0.0.",[411,412],"hr",{},[244,414,415,418,419,418,422],{},[262,416,417],{"href":205},"← Импорт"," | ",[262,420,421],{"href":181},"↑ Содержание",[262,423,424],{"href":215},"Парсинг XML →",[426,427,428],"note",{},[244,429,430,431,436],{},"Источник: ",[262,432,435],{"href":433,"rel":434},"https:\u002F\u002Fgithub.com\u002Fbx-shef\u002Finsync\u002Fblob\u002Fmain\u002Fdocs\u002F3_api.md",[266],"insync\u002Fdocs\u002F3_api.md"," — правки туда, сайт пересобирается сам.",{"title":105,"searchDepth":438,"depth":438,"links":439},3,[],"md",{},true,"---\ntitle: \"[`\\\\Shef\\\\InSync\\\\Api`] API\"\n---\n\nОбращение к внешнему API по HTTP — наследник `\\Shef\\InSync\\Api\\AConnector`.\n\n> Пример смотреть в модуле **[shef.demosync](https:\u002F\u002Fmarketplace.1c-bitrix.ru\u002Fsolutions\u002Fshef.demosync\u002F)**\n\n| класс | что делает |\n|---|---|\n| AConnector | запрос через `HttpClient` ядра, разбор ответа, логирование ошибок в shef.problems |\n| Headers | маска секретных заголовков для лога |\n\nЧто пишете вы:\n\n* `getPath()` — адрес по имени функции API;\n* `getModuleId()` — модуль, от имени которого пишутся проблемы;\n* при необходимости `processSuccess()`, `processError()`, `processError50x()` —\n  разбор ответа. Помните, что 200 — ещё не успех бизнес-логики.\n\n`\\Shef\\InSync\\Api\\AConnector::sendRequest()` отправляет запрос (`GET` —\nпараметры в адрес, остальные методы — телом) и возвращает `Result` с\nотправленным и полученным. Таймауты — из опций объекта: `socketTimeout` (30),\n`streamTimeout` (60), `waitResponse` (да). Значения приводятся к типам ядра: секунды — целым, `waitResponse` — флагом.\n\nПри ошибке запрос пишется в лог проблем. Заголовки с `auth`, `token`, `key`,\n`secret`, `pass`, `cookie`, `session`, `sign`, `access` в имени уходят туда маской\n(`\\Shef\\InSync\\Api\\Headers::mask()`); параметры — как есть, секреты в них не\nкладите. Ответ не 200 без ошибок соединения даёт ошибку `status: \u003Cкод>`, а не\nпустую строку, как до 2.0.0.\n\n---\n\n[← Импорт](\u002Fmodules\u002Finsync\u002Fimport) | [↑ Содержание](\u002Fmodules\u002Finsync) | [Парсинг XML →](\u002Fmodules\u002Finsync\u002Fxml)\n\n::note\nИсточник: [insync\u002Fdocs\u002F3_api.md](https:\u002F\u002Fgithub.com\u002Fbx-shef\u002Finsync\u002Fblob\u002Fmain\u002Fdocs\u002F3_api.md) — правки туда, сайт пересобирается сам.\n::\n\n",{"title":209,"description":212},"259mi8MuAVaaLjgCJz4v0Pm449PgysCpvH_sIn5g6fs",[447,448],{"title":204,"path":205,"stem":206,"description":207,"children":-1},{"title":214,"path":215,"stem":216,"description":217,"children":-1},1790857270487]