Skip to main content

Bitrix24 REST API wrapper provides 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 a simple API wrapper for working with Bitrix24 REST API over webhooks.

Features

  • Works both with cloud and on-premises versions of bitrix24, much more
  • Super easy for setting up. No OAuth implemetation required
  • Compatible with latests Bitrix24 REST API

Requirements

  • Python 2.6+ or 3.2+
  • requests

Installation

pip install bitrix24-rest

Quickstart

from bitrix24 import *

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

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

Advanced usage

You can define filters and additional parameters in any order:

bx24.callMethod('crm.deal.list',
                order={'STAGE_ID': 'ASC'},
                filter={'>PROBABILITY': 50},
                select=['ID', 'TITLE', 'STAGE_ID', 'PROBABILITY'])

Catch the server error with exception:

try:
    bx24.callMethod('tasks.task.add', fields={'TITLE': 'task for test', 'RESPONSIBLE_ID': 1})
except BitrixError as message:
    print(message)

Notes

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

Tests

python -m unittest discover

Author

Akop Kesheshyan - akop.kesheshyan@icloud.com

New contributers and pull requests are welcome.

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-1.1.1.tar.gz (5.5 kB view hashes)

Uploaded Source

Built Distribution

bitrix24_rest-1.1.1-py2.py3-none-any.whl (6.5 kB view hashes)

Uploaded Python 2 Python 3

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