bitrix-rest-api
v0.1.6
Published
Client for Bitrix / Bitrix24 REST API suitable for NodeJS, Deno or browsers.
Downloads
31
Maintainers
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
- Create an incoming webhook in your Bitrix / Bitrix24 test instance.
- Copy
environment.test.json.dist
toenvironment.test.json
- Replace
https://example.com/rest/<userId>/<webhookApiKey>
with your Bitrix REST API webhook. Example: https://example.com/rest/1/dfkgjte78d5wdfgh - Run
nx test bitrix-rest-api
ornx run bitrix-rest-api:test
to execute the unit tests via Jest.
License
MIT (c) 2021 Viacheslav Dobromyslov <[email protected]>