Bitrix24 REST API client for local use

• 🔥 No bullshit
• ✨ Expressive API
• 💪 Strongly typed methods and requests results with TypeScript
• 🚀 Handles records batching and rate limiting for you
• ❤️ Promise-based

Install

npm install @batformat/bx-request

Usage

Init client with Bitrix API endpoint and access token and use the client to ease your Bitrix pain:

import Bitrix from '@batformat/bx-request'

const bitrix = Bitrix('https://PORTAL_NAME.bitrix24.ru/rest', 'ACCESS_TOKEN')

// Get deal
bitrix.deals.get('77')
  .then(({ result }) => {
    // Get typed payload
    const { TITLE } = result // string
    console.log(TITLE)
  })
  .catch(console.error)

// Get all deals
bitrix.deals.list({ select: ["*", "UF_*"] })
  .then(({ result }) => {
    const titles = result.map((e) => e.TITLE)
    console.log(titles)
  })
  .catch(console.error)

API

• Generic
  • call()
  • list()
  • batch()
• CRM
  • Company
  • Contact
  • Currency
  • Deal
  • Lead
  • Status
• User