bitrix24-rest-api について
Bitrix24 REST APIを利用する開発者向けのクライアント側ガイドです。認証、呼び出し、イベント、エラー、SDKを扱い、メソッドの確認と認証情報の保護を重視します。
主な機能
- 01REST呼び出しとページングの案内
- 02Webhook、OAuth、権限範囲の説明
- 03制限、エラー、再試行のルール
- 04イベントとREST 3.0の案内
- 05複数SDKの利用ガイド
活用シーン
- 01Bitrix24クラウド向けREST連携の開発
- 02認証方式と最小権限の選択
- 03一括呼び出し、制限、APIエラーへの対応
- 04イベントと受信リクエストの安全な処理
MCP 対応
文書検索にはbitrix24-ai-toolsのMCPを利用でき、APIメソッドは対象ポータルのmethod.getで確認するよう案内しています。
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ bxmaximum/ bitrix-framework-skills --skill bitrix24-rest-apiインストール後、Claude Code で/bitrix24-rest-apiを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
rules/auth.mdcalls.mdevents-placements.mdlimits-errors.mdon-premise.mdrest-v3.mdsdk.md詳細
Bitrix24 REST API(クライアント側)
ベースライン:Bitrix24 クラウド、オンプレミスの main 23.0 以降 · 検証済み:rest 26.650.0(main 26.800.0)、b24restdocs 2026-09-30
REST の利用。モジュールで独自のメソッドを登録する場合:bitrix-rest。エージェント(MCP)、Vibecode 向けのドキュメント検索:bitrix24-ai-tools。
| タスク | 参照先 |
|---|---|
| Webhook とローカルアプリ、Marketplace OAuth の比較、トークンの更新、スコープ | rules/auth.md |
| URL と本文の形式、リスト、高速なページネーション、バッチ | rules/calls.md |
| 制限、エラーコード、再試行とバックオフ | rules/limits-errors.md |
| イベント、アウトバウンド Webhook、オフラインイベント、プレースメント | rules/events-placements.md |
REST 3.0(/rest/api/)、Idempotency-Key、OpenAPI | rules/rest-v3.md |
| b24phpsdk、b24jssdk、BX24.js、CRest | rules/sdk.md |
| オンプレミス固有の情報 | rules/on-premise.md |
不変条件
- メソッド、フィールド、フィルターを推測してはいけません。必ず調べてください(
bitrix24-ai-toolsの MCP、または対象ポータルのmethod.getを使用します)。 - Webhook URL、
client_secret、トークン、application_tokenは環境変数またはシークレットストアに保存し、VCS、ブラウザーコード、ログ、共有 URL には保存しないでください。 - 最小権限の原則に従い、シナリオで呼び出すスコープのみを要求してください。呼び出しは、そのユーザーの権限でも実行されます。
- HTTP ステータスではなく、
errorキー(バッチ内ではresult.result_error)でエラーを検出してください。 - 受信するすべての呼び出し(イベント、プレースメント、インストール)は、
auth.application_tokenがそのmember_idに保存されている値と一致するまで、信頼できないものとして扱ってください。 - HTTPS のみを使用してください。ハンドラーは速やかに応答し、処理をキューに入れて、冪等に実行してください。
コメント
Markdown 対応