bitrix-rest
Серверный REST своего PHP-модуля коробки: REST 3.0, Engine restIntegration, OnRestServiceBuildDescription, события и scopes. Для публикации методов; клиентские вызовы — bitrix24-rest-api.
How do I install this agent skill?
npx skills add https://github.com/bxmaximum/bitrix-framework-skills --skill bitrix-restIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill provides comprehensive documentation and guidelines for developing server-side REST APIs within Bitrix24 PHP modules. It covers implementation via REST 3.0, Engine controllers, and classic method maps, while emphasizing security best practices like mandatory permission checks. No malicious patterns, obfuscation, or unauthorized data access were detected.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
What does this agent skill do?
Серверный REST (rest)
Baseline: main 23.0+ · Verified: rest 26.1100.0, main 26.1000.0
Перед PHP-кодом один раз прочитай bitrix-framework. Здесь публикуют методы своего модуля. Клиентские вызовы (вебхуки, OAuth, batch, лимиты, ошибки): bitrix24-rest-api.
| Вариант | Регистрация | Открыть |
|---|---|---|
REST 3.0 (/rest/api/…, DTO, JSON) | секция rest в .settings.php модуля | rules/v3.md |
| Идемпотентность V3, динамические перечисления, отложенный batch | атрибуты и очередь Messenger | rules/v3-runtime.md |
| Engine-контроллер, общий с AJAX | .settings.php → controllers.restIntegration.enabled | rules/classic.md |
| Классическая карта методов, REST-события и встройки | событие rest:OnRestServiceBuildDescription | rules/classic.md |
Новые API публикуй через REST 3.0 (Since rest 26.200*); на старом модуле используй Engine + restIntegration. Классическая карта нужна для событий, встроек и явных имён методов.
Общие правила
- Подключи
Loader::includeModule('rest'). Код размещай в установленном/local/modules/<vendor.module>/. - REST не использует CSRF: запрос авторизует токен приложения или вебхука. В каждом действии проверяй права пользователя на данные.
- Scopes определяют разрешения приложения. Сохраняй стабильные имена и документируй их.
- Возвращай REST-ошибки: исключения V3,
addErrorконтроллера,\Bitrix\Rest\RestException. Не выводи HTML и не вызывайdie(). - Для собственных методов наследуй документированные базовые контроллеры. Не наследуй внутренние сервисы и не реализуй
Bitrix\Rest\Internal\*: их сигнатуры меняются даже в промежуточном релизе (26.650:Engine\Access,Api\User,IncomingWebhookRepositoryInterface). Используй композицию. - Блоки Landing и встройки через REST:
bitrix-landing.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/bxmaximum/bitrix-framework-skills/bitrix-rest">View bitrix-rest on skillZs</a>