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-python-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.

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.0.0.tar.gz (4.9 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.0.0-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bitrix24-rest-1.0.0.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.7.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for bitrix24-rest-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e7a912f6cb92d933a38f506606baaf05a187296bcd2f07f0577e7186c23bebe6
MD5 6e2134cb21400a81f6b0931e27a74efa
BLAKE2b-256 ce4b87c9a5b6add787e60621ce77457dd55673018bceb239fa2b8d9b63a5a04d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bitrix24_rest-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.7.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for bitrix24_rest-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2dee1678197e6074cde73dd8207e35967e21b61ae50197c7d0520ab62b157f8a
MD5 cda02383fe243b3fb461029e89e6428e
BLAKE2b-256 b982df09287ab72d8e31e400f74bde76cee6b6ed34260c60422d8081dd9d3323

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