JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 7
  • Score
    100M100P100Q56019F
  • License MIT

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

Package Exports

  • bitrix-rest-api

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bitrix-rest-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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>