bitrix-rest
Expose your module's methods through the rest module — REST 3.0 RestController, Engine controllers with restIntegration, OnRestServiceBuildDescription, scopes. Use when adding REST methods, events or placements to a /local module.
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 is a technical documentation file providing guidance on developing REST API integrations for the Bitrix CMS. It follows best practices, including explicit warnings to protect secrets and avoid committing passwords to version control. No malicious patterns or security risks were identified.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
What does this agent skill do?
REST server side (rest)
Baseline: main 23.0+ · Verified: rest 26.650.0, main 26.800.0
Publishing methods from your module. Calling REST (webhooks, OAuth, batch, limits, error handling on the client): bitrix24-rest-api.
| Path | Registration | Read |
|---|---|---|
REST 3.0 (/rest/api/…, DTO, JSON) | module .settings.php → rest section | rules/v3.md |
| Engine controller (same class as AJAX) | .settings.php → controllers.restIntegration.enabled | rules/classic.md |
| Classic method map, REST events, placements | event rest:OnRestServiceBuildDescription | rules/classic.md |
For new APIs: REST 3.0 (Since rest 26.200*), fallback Engine controller + restIntegration. Classic descriptions: for REST events, placements, or explicit method names.
Invariants
Loader::includeModule('rest'); code lives in/local/modules/<vendor.module>/, the module must be installed.- REST calls have no CSRF: authentication is the app token/webhook. Check the user's rights inside every action.
- Scopes are the permission units granted to apps. Keep names stable and documented.
- Return errors in REST form (v3 exceptions, controller
addError,\Bitrix\Rest\RestException), never HTML ordie(). - Don't extend
restclasses or implementBitrix\Rest\Internal\*contracts: signatures change in minor releases (26.650:Engine\Access,Api\User,IncomingWebhookRepositoryInterface). Compose instead. - Landing blocks and placements via 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>