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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 2Python 3

File details

Details for the file bitrix24-rest-1.1.1.tar.gz.

File metadata

  • Download URL: bitrix24-rest-1.1.1.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.5.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for bitrix24-rest-1.1.1.tar.gz
Algorithm Hash digest
SHA256 c8be9ad8f40b04497fa9407801e67b796665f13d8ad90ed01293548d214ec864
MD5 36724f4eecdcfa1e3a9793bc7a2bed11
BLAKE2b-256 1a378978b4727d0d2d7d14e446d435b4847983661be8ab5fea9144eba548daaf

See more details on using hashes here.

File details

Details for the file bitrix24_rest-1.1.1-py2.py3-none-any.whl.

File metadata

  • Download URL: bitrix24_rest-1.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.5.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for bitrix24_rest-1.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 20c48c1b9679988d77eeddaf503254c8ca018bb19db163754fa8a9a28b44de14
MD5 2e08414db10578d4653a203e4de0776a
BLAKE2b-256 c96baf27237786dd5eee91756963c2d597a8001848f3989460aeb773213208de

See more details on using hashes here.

Supported by

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