Skip to main content

Easy way to communicate with bitrix24 portal over REST without OAuth

Project description

Bitrix24 REST API for Python

Easy way to communicate with bitrix24 portal over REST without OAuth 2.0

Description

Bitrix24 REST is an API wrapper for working with Bitrix24 REST API over webhooks. No OAuth 2.0 required. It's easy to use and super lightweight, with minimal dependencies.

Features

  • Works with both cloud and on-premises versions of Bitrix24.
  • Super easy to setup. No OAuth 2.0 infrastructure required.
  • Built with data analysis in mind and fully compatible with Jupyter Notebook.
  • Fetch paginated data at once without hassle.
  • Works with large datasets and handles rate limits.

Installation

pip install bitrix24-rest

Quickstart

from bitrix24 import Bitrix24

bx24 = Bitrix24('https://example.bitrix24.com/rest/1/33olqeits4avuyqu')

print(bx24.callMethod('crm.product.list'))

In async mode:

import asyncio
from bitrix24 import bitrix24

async def main():
    bx24 = Bitrix24('https://example.bitrix24.com/rest/1/33olqeits4avuyqu')
    result = await bx24.callMethod('crm.product.list')
    print(result)

asyncio.run(main())

Advanced usage

Notes

List methods return all available items at once. For large collections of data use limits.

Development

New contributors and pull requests are welcome. If you have any questions or suggestions, feel free to open an issue.

Code comes with makefile for easy code base management. You can check make help for more details.

make init install # to create a local virtual environment and install dependencies

make test # to run tests

make lint # to run linter

I suggest to use make all before committing your changes as it will run all the necessary checks.

Support this project

You can support this project by starring ⭐, sharing 📤, and contributing.

You can also support the author by buying him a coffee ☕. Click sponsor button on the top of the page.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bitrix24_rest-2.0.3.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

bitrix24_rest-2.0.3-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file bitrix24_rest-2.0.3.tar.gz.

File metadata

  • Download URL: bitrix24_rest-2.0.3.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for bitrix24_rest-2.0.3.tar.gz
Algorithm Hash digest
SHA256 7649da7a55b6f11665bb590a8f326056f303f0ec45cdbece459060416aee9ba1
MD5 bf9a1f04f776e46ca5af814fa82503d2
BLAKE2b-256 dce7477db32490064cb2c7307f01ebe43e6e6028f169520c3bbcc2f779e68862

See more details on using hashes here.

File details

Details for the file bitrix24_rest-2.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for bitrix24_rest-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4a6d88d1b84cd028501ae502014ad1b478ccd8e31c429a5f9a2b88dae462d2a1
MD5 3d1a4b96fdb8d745caaf5648b1468734
BLAKE2b-256 ee38ff3cfd95092e4c60e1762be0d1a8d801b3aa32a3a0e22736ae28d438860a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page