AInq.Bitrix24.Abstraction

Base client for Bitrix24 Rest API


Keywords
AInq, Bitrix24, dotnet
License
Apache-2.0
Install
Install-Package AInq.Bitrix24.Abstraction -Version 3.0.0-rc.2.1

Documentation

AInq.Bitrix24

GitHub release (latest by date) GitHub

AInq

What is it?

Client for Bitrix24 Rest API

Project status

Unfortunately, at the moment the development of the project is suspended. In the near future, only bug fixes and minor technical updates will be released. There is a plan to create a new strongly typed API client (primarily CRM and tasks), but there are no specific deadlines due to the workload on the main project.

Статус проекта

К сожалению, в настоящий момент развитие проекта приостановлено. В ближайшее время будут выходить только исправления ошибок и небольшие технические обновления. Существует план создания нового строго типизированного клиента API (в первую очередь CRM и задач), но никаких конкретных сроков нет по причине загруженности на основном проекте.

New in 2.0

Split interface, implementation and high-level method calls (in future) to separate packages

Packages description

Nuget AInq.Bitrix24.Abstraction

IBitrix24Client interface.

Nuget AInq.Bitrix24

Base client implementation with GET/POST method calls, authentication and request-per-second limit (only in Bitrix24ClientTimeoutBase). Provided client are abstract: methods to interact with some persistent storage (for access and refresh tokens) and to obtain OAuth authentication code should be implemented.

Nuget AInq.Bitrix24.Background

Integration with AInq.Background conveyor. DO NOT use IBitrix24Client implementations with internal timeout control with this package.

Nuget AInq.Bitrix24.Api

High-level API methods will be added here.

Currently available:

  • Get, List, Update, Create, Delete methods for basic CRM entities (lead, deal, contact, company)

There is currently no plan to implement all API methods, first priority is CRM methods implementation.

Дальнейшая разработка

Данный пакет будет дополняться методами общего назначения по мере того, как их реализации будут стабилизироваться и тестироваться в реальном приложении, находящемся сейчас в активной разработке. Разработка ведется с учетом реально встречающегося странного поведения API Битрикс24 (например отдача значения false в необязательных пользовательских полях числовых типов). Функциональность иногда приносится в жертву надежности, API может отличаться от официального. Таков путь.

Documentation

As for now documentation is provided in this document and by XML documentation inside packages.

Contribution

If you find a bug, have a question or something else - you are friendly welcome to open an issue.

License

Copyright © 2021 Anton Andryushchenko. AInq.Bitrix24 is licensed under Apache License 2.0