@ 2bad/ bitrix (帮助)
Bitrix24 REST API客户端用于零运行时间依赖的TypeScript.
为什么
Bitrix24将半成品的API用于生产,并留给您去了解它们的实际工作方式. 每个模块都有自己的字段名称,错误格式和呼号规则. 文档不完整,过时或错误,行为中有很大一部分完全没有记录,支持不会帮助你. 每个集成都变成了倒向工程,一次固定一个被打破的假设.
我们这样做是为了让你不必这么做 这个客户端拿走了Bitrix向它扔的任何东西,并给了你一些你实际上可以建立的东西.
你得到的东西
- 别扯了
- 表达式 API
- 严格输入, 包括您的门户的自定义字段
- 处理您的批量、费率限制和重试
- 零依赖,到处跑
fetch已经
安装
npm install @2bad/bitrix
仅限无害环境管理。 要求节点.js 26或后.
快开始
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'] })
实例
- 连接中: webhoks, OAuth, 速率限制, 日志和自定义
fetch - 服务:交易、线索、联系人、公司、活动、智能流程、链接联系人、产品、状况、货币和用户
- 名单: pagination 模式,自上次同步以来的变化和进展
- 批量和批量写作: 每个请求有许多命令,
createMany, (中文(简体) ),updateMany, (中文(简体) ),deleteMany - 类型: 从您的门户输入用户字段类型并输入其他方法
- 错误数字 :
BitrixError,重复和取消 - 从 2.x 移动
API 密码
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
bitrix-types [--url <rest url>] [--out <file>] [--entities deal,lead,contact,company]
每个错误都是 BitrixError 与 code, (中文(简体) ), description, (中文(简体) ), method 财务报告和审定财务报表 status。 。 。 .
许可证
麻省理工学院