# 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
```python
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:
```python
bx24.callMethod('crm.deal.list',
order={'STAGE_ID': 'ASC'},
filter={'>PROBABILITY': 50},
select=['ID', 'TITLE', 'STAGE_ID', 'PROBABILITY'])
```
Catch the server error with exception:
```python
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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Motexc/bitrix24-python-rest.git",
"name": "bitrix24-rest-motexc",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "bitrix24 api rest fork",
"author": "Andrey Yakovlev",
"author_email": "modifikator97@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7e/b0/d4026e52a4b047e19bfe25afc49f3d9147ba60b71d95c8074c9534e32a4a/bitrix24-rest-motexc-1.1.5.tar.gz",
"platform": null,
"description": "# Bitrix24 REST API for Python\r\n\r\nEasy way to communicate with bitrix24 portal over REST without OAuth 2.0\r\n\r\n## Description\r\n\r\nBitrix24 REST is a simple API wrapper for working with Bitrix24\r\nREST API over webhooks.\r\n\r\n## Features\r\n\r\n- Works both with cloud and on-premises versions of bitrix24, much more\r\n- Super easy for setting up. No OAuth implemetation required\r\n- Compatible with latests Bitrix24 REST API\r\n\r\n## Requirements\r\n- Python 2.6+ or 3.2+\r\n- requests\r\n\r\n## Installation\r\n```\r\npip install bitrix24-rest\r\n```\r\n\r\n## Quickstart\r\n\r\n```python\r\nfrom bitrix24 import *\r\n\r\nbx24 = Bitrix24('https://example.bitrix24.com/rest/1/33olqeits4avuyqu')\r\n\r\nprint(bx24.callMethod('crm.product.list'))\r\n```\r\n\r\n## Advanced usage\r\n\r\nYou can define filters and additional parameters in any order:\r\n\r\n```python\r\nbx24.callMethod('crm.deal.list',\r\n order={'STAGE_ID': 'ASC'},\r\n filter={'>PROBABILITY': 50},\r\n select=['ID', 'TITLE', 'STAGE_ID', 'PROBABILITY'])\r\n```\r\n\r\nCatch the server error with exception:\r\n\r\n```python\r\ntry:\r\n bx24.callMethod('tasks.task.add', fields={'TITLE': 'task for test', 'RESPONSIBLE_ID': 1})\r\nexcept BitrixError as message:\r\n print(message)\r\n```\r\n\r\n## Notes\r\nList methods return all available items at once. For large collections\r\nof data use limits.\r\n\r\n## Tests\r\n\r\n```\r\npython -m unittest discover\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A fork of bitrix24-rest package, abandoned by it's author Akop Kesheshyan",
"version": "1.1.5",
"project_urls": {
"Homepage": "https://github.com/Motexc/bitrix24-python-rest.git"
},
"split_keywords": [
"bitrix24",
"api",
"rest",
"fork"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9768eaaf5a105e0d7e5cc57b5fdb2edd236f4c89f9591f590a395214d7f59530",
"md5": "e4ee41e6a646f7180e0fce05acec8c6f",
"sha256": "3863b06de39e730258d588c41bb6b2d2d4c50b153fab0dc112d477fe561e598e"
},
"downloads": -1,
"filename": "bitrix24_rest_motexc-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e4ee41e6a646f7180e0fce05acec8c6f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6819,
"upload_time": "2024-04-11T13:53:50",
"upload_time_iso_8601": "2024-04-11T13:53:50.776624Z",
"url": "https://files.pythonhosted.org/packages/97/68/eaaf5a105e0d7e5cc57b5fdb2edd236f4c89f9591f590a395214d7f59530/bitrix24_rest_motexc-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7eb0d4026e52a4b047e19bfe25afc49f3d9147ba60b71d95c8074c9534e32a4a",
"md5": "88649e4439c02e5e9b25e784cc873399",
"sha256": "b21bbcdb0fcd747d714fe5400553cca356d30b07bcb5caa6e08bbf171fda8049"
},
"downloads": -1,
"filename": "bitrix24-rest-motexc-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "88649e4439c02e5e9b25e784cc873399",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5928,
"upload_time": "2024-04-11T13:53:53",
"upload_time_iso_8601": "2024-04-11T13:53:53.246723Z",
"url": "https://files.pythonhosted.org/packages/7e/b0/d4026e52a4b047e19bfe25afc49f3d9147ba60b71d95c8074c9534e32a4a/bitrix24-rest-motexc-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-11 13:53:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Motexc",
"github_project": "bitrix24-python-rest",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bitrix24-rest-motexc"
}
JSON
