mcpField
B
bitrix24-rest-api

bitrix24-rest-api

github.com/bxmaximumDevelopment4785 installsUpdated 2w ago
Repository

About bitrix24-rest-api

A client-side guide for developers consuming the Bitrix24 REST API. It covers authentication, calls, events, errors, and SDKs, with explicit guidance on verifying methods and protecting credentials.

Key features

  1. 01REST calls and pagination guidance
  2. 02Webhook, OAuth, and scope guidance
  3. 03Limits, errors, and retry rules
  4. 04Events and REST 3.0 guidance
  5. 05Guidance for multiple SDKs

Use cases

  1. 01Build REST integrations for Bitrix24 cloud
  2. 02Choose authentication and least-privilege scopes
  3. 03Handle batches, limits, and API errors
  4. 04Securely process events and inbound requests

MCP support

The project points to bitrix24-ai-tools MCP for documentation lookup, and recommends method.get on the target portal to verify API methods.

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/bxmaximum/bitrix-framework-skills --skill bitrix24-rest-api

After installing, type/bitrix24-rest-apiin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

rules/
auth.md
calls.md
events-placements.md
limits-errors.md
on-premise.md
rest-v3.md
sdk.md

Details

From the project README

Bitrix24 REST API (client side)

Baseline: Bitrix24 cloud; on-premise main 23.0+ · Verified: rest 26.650.0 (main 26.800.0), b24restdocs 2026-09-30

Consuming REST. Registering your own methods in a module: bitrix-rest. Docs lookup for agents (MCP), Vibecode: bitrix24-ai-tools.

TaskRead
Webhook vs local app vs Marketplace OAuth, token refresh, scopesrules/auth.md
URL and body format, lists, fast pagination, batchrules/calls.md
Limits, error codes, retry and backoffrules/limits-errors.md
Events, outbound webhooks, offline events, placementsrules/events-placements.md
REST 3.0 (/rest/api/), Idempotency-Key, OpenAPIrules/rest-v3.md
b24phpsdk, b24jssdk, BX24.js, CRestrules/sdk.md
On-premise specificsrules/on-premise.md

Invariants

  • Never guess a method, field or filter: look it up (MCP from bitrix24-ai-tools, or method.get on the target portal).
  • Webhook URLs, client_secret, tokens and application_token live in env or a secret store; never in VCS, browser code, logs or shared URLs.
  • Least privilege: request only the scopes the scenario calls. A call also runs with the rights of its user.
  • Detect errors by the error key (and result.result_error in batch), not by HTTP status.
  • Treat every inbound call (event, placement, install) as untrusted until auth.application_token matches the value stored for its member_id.
  • HTTPS only. Handlers acknowledge fast, queue the work and process it idempotently.

Comments

Markdown supported