bitrix-rest-api
TypeScript icon, indicating that this package has built-in type declarations

0.1.6 • Public • Published

bitrix-rest-api

Status

Work in progress.

Description

Client for Bitrix / Bitrix24 REST API suitable for NodeJS, Deno or browsers.

Features

  • TypeScript
  • Fully defined interfaces for data provided by bitrix-rest-api-core
  • An improved documentation written in English.
  • NodeJS, Deno and browser compatible.

Installation

npm install bitrix-rest-api

or

yarn add bitrix-rest-api

REST API

  • Sale (Online Shop)

Running unit tests

  1. Create an incoming webhook in your Bitrix / Bitrix24 test instance.
  2. Copy environment.test.json.dist to environment.test.json
  3. Replace https://example.com/rest/<userId>/<webhookApiKey> with your Bitrix REST API webhook. Example: https://example.com/rest/1/dfkgjte78d5wdfgh
  4. Run nx test bitrix-rest-api or nx run bitrix-rest-api:test to execute the unit tests via Jest.

License

MIT (c) 2021 Viacheslav Dobromyslov <viacheslav@dobromyslov.ru>

Package Sidebar

Install

npm i bitrix-rest-api

Weekly Downloads

3

Version

0.1.6

License

MIT

Unpacked Size

90.6 kB

Total Files

108

Last publish

Collaborators

  • dobromyslov