# @2bad/bitrix 中文文档

规范地址：https://npmcn.com/package/%402bad/bitrix/

版本：3\.0\.0
npm 元数据更新时间：2026-11-02T03:28:32.235Z
中文译文更新时间：2026-11-06T08:29:44.418Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%402bad/bitrix
原文对照：https://npmcn.com/package/%402bad/bitrix/?lang=original
项目主页：https://github.com/2BAD/bitrix#readme
源码仓库：https://github.com/2BAD/bitrix

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：169 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=26
- 运行依赖：0 个
- 首次发布：2019-08-29T22:50:47.384Z
- 最新版本发布：2026-11-02T03:28:31.890Z
- 近 30 天下载量：3833（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 1 个）

## 中文简介

Bitrix24 REST API 客户端不烂

## 安装

```sh
npm install @2bad/bitrix
```

也可以使用：`pnpm add @2bad/bitrix`、`yarn add @2bad/bitrix`、`bun add @2bad/bitrix`

## README

# @ 2bad/ bitrix (帮助)

[![NPM version](https://img.shields.io/npm/v/@2bad/bitrix)](https://www.npmjs.com/package/@2bad/bitrix) [![License](https://img.shields.io/npm/l/@2bad/bitrix)](https://www.npmjs.com/package/@2bad/bitrix) [![Code coverage](https://img.shields.io/codecov/c/github/2BAD/bitrix)](https://codecov.io/gh/2BAD/bitrix) [![GitHub Build Status](https://img.shields.io/github/actions/workflow/status/2BAD/bitrix/build.yml)](https://github.com/2BAD/bitrix/actions/workflows/build.yml)

Bitrix24 REST API客户端用于零运行时间依赖的TypeScript.

## 为什么

Bitrix24将半成品的API用于生产,并留给您去了解它们的实际工作方式. 每个模块都有自己的字段名称,错误格式和呼号规则. 文档不完整,过时或错误,行为中有很大一部分完全没有记录,支持不会帮助你. 每个集成都变成了倒向工程,一次固定一个被打破的假设.

我们这样做是为了让你不必这么做 这个客户端拿走了Bitrix向它扔的任何东西,并给了你一些你实际上可以建立的东西.

## 你得到的东西

-   别扯了
-   表达式 API
-   严格输入, 包括您的门户的自定义字段
-   处理您的批量、费率限制和重试
-   零依赖,到处跑 `fetch` 已经

## 安装

```sh
npm install @2bad/bitrix
```

仅限无害环境管理。 要求节点.js 26或后.

## 快开始

```ts
import { createClient } from '@2bad/bitrix'

const bitrix = createClient({ url: 'https://portal.bitrix24.com/rest/1/WEBHOOK_TOKEN' })

const deal = await bitrix.deals.get(77)
console.log(deal.TITLE, deal.STAGE_ID) // Pump delivery C2:WON

const open = await bitrix.deals.list({ filter: { CLOSED: 'N' }, select: ['ID', 'TITLE'] })
```

## 实例

-   [连接中](https://npmcn.com/package/%402bad/bitrix/examples/connecting.md): webhoks, OAuth, 速率限制, 日志和自定义 `fetch`
-   [服务](https://npmcn.com/package/%402bad/bitrix/examples/services.md):交易、线索、联系人、公司、活动、智能流程、链接联系人、产品、状况、货币和用户
-   [名单](https://npmcn.com/package/%402bad/bitrix/examples/lists.md): pagination 模式,自上次同步以来的变化和进展
-   [批量和批量写作](https://npmcn.com/package/%402bad/bitrix/examples/batch.md): 每个请求有许多命令, `createMany`, (中文(简体) ), `updateMany`, (中文(简体) ), `deleteMany`
-   [类型](https://npmcn.com/package/%402bad/bitrix/examples/types.md): 从您的门户输入用户字段类型并输入其他方法
-   [错误](https://npmcn.com/package/%402bad/bitrix/examples/errors.md)数字 : `BitrixError`,重复和取消
-   [从 2.x 移动](https://npmcn.com/package/%402bad/bitrix/examples/migrating.md)

## API 密码

```ts
function createClient(options: ClientOptions): Client

type Client = {
  call(method, params?, options?: { raw?; signal? }): Promise<Result> // the whole response with { raw: true }
  list(method, params?, options?: PaginateOptions): Promise<Row[]>
  paginate(method, params?, options?: PaginateOptions): AsyncGenerator<Row>
  batch(commands, options?: { halt?; signal? }): Promise<{ results; errors }>

  activities: CrmService<Activity>
  companies: CrmService<Company> & { contacts: Links }
  contacts: CrmService<Contact> & { companies: Links }
  currencies: CurrenciesService
  deals: CrmService<Deal> & { productRows: ProductRows; contacts: Links }
  items(entityTypeId): ItemsService // smart processes and other crm.item.* types
  leads: CrmService<Lead> & { productRows: ProductRows; contacts: Links }
  products: ProductsService
  statuses: StatusesService
  users: UsersService
}

type CrmService<Entity> = {
  fields(): Promise<Fields>
  get(id): Promise<Entity>
  list(params?, options?: PaginateOptions): Promise<Entity[]> // rows typed by params.select
  paginate(params?, options?: PaginateOptions): AsyncGenerator<Entity>
  changedSince(since: Date | string, params?, options?): AsyncGenerator<Entity> // oldest change first
  create(fields, params?): Promise<number>
  update(id, fields, params?): Promise<boolean>
  delete(id): Promise<boolean>
  createMany(items, params?): Promise<BulkResult<number>>
  updateMany(items: { id; fields }[], params?): Promise<BulkResult<boolean>>
  deleteMany(ids): Promise<BulkResult<boolean>>
}

type ProductRows = { get(id): Promise<ProductRow[]>; set(id, rows): Promise<boolean> }
type Links = { get(id); set(id, links); add(id, link); delete(id, linkedId); clear(id) }
type ItemsService = { fields(); get(id); list(params?); paginate(params?); changedSince(since, params?); create(fields); update(id, fields); delete(id) }
type ProductsService = { fields(iblockId); get(id); list(params); paginate(params); create(fields); update(id, fields); delete(id) }
type StatusesService = { fields(); get(id); list(params?); create(fields); update(id, fields); delete(id, { forced? }) }
type CurrenciesService = { fields(); get(code); list(params?); create(fields); update(code, fields); delete(code); base(); setBase(code) }
type UsersService = { fields(); current(); get(id); list(params?); paginate(params?) }

type PaginateOptions = {
  mode?: 'cursor' | 'offset' | 'modified' // cursor by default, modified needs since
  since?: Date | string
  modifiedField?: string // DATE_MODIFY by default
  idField?: string // ID by default
  signal?: AbortSignal
  onProgress?: (progress: { read: number; total?: number }) => void
}

type BulkResult<R> = { results: (R | undefined)[]; errors: (BitrixError | undefined)[] } // in input order
```

```sh
bitrix-types [--url <rest url>] [--out <file>] [--entities deal,lead,contact,company]
```

每个错误都是 `BitrixError` 与 `code`, (中文(简体) ), `description`, (中文(简体) ), `method` 财务报告和审定财务报表 `status`。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @2bad/bitrix 是什么？

Bitrix24 REST API 客户端不烂

### 如何安装 @2bad/bitrix？

在项目目录运行 npm install @2bad/bitrix，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 bitrix-types，可以用 npx bitrix-types 直接运行。

### @2bad/bitrix 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @2bad/bitrix 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @2bad/bitrix 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=26。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @2bad/bitrix 可以商用吗？

@2bad/bitrix 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @2bad/bitrix 的下载量有多少？

根据 npm 官方下载统计，@2bad/bitrix 在 2026/10/05 – 2026/11/03 这 30 天内被下载 3,833 次，日均约 128 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @2bad/bitrix 还在维护吗？

最新版本 3\.0\.0 发布于 2026/11/02（4 天前）；至今共发布 14 个版本，其中过去 12 个月发布了 1 个；首次发布于 2019/08/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。