Giter Club home page Giter Club logo

bitrix24-python-rest's Introduction

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.