diff --git a/README.md b/README.md index c6d61fe..96a4199 100644 --- a/README.md +++ b/README.md @@ -35,10 +35,10 @@ API wrapper для Питона для быстрого получения да - Высокоуровневые списочные методы для сокращения количества необходимого кода. Большинство операций занимают только одну строку кода. Обработка параллельных запросов, упаковка запросов в батчи и многое другое убрано "под капот". - Позволяет задавать параметры запроса именно в таком виде, как они приведены в [документации к Bitrix24 REST API](https://dev.1c-bitrix.ru/rest_help/index.php). Параметры проверяются на корректность для облегчения отладки. - Выполнение запросов автоматически сопровождается прогресс-баром из пакета `tqdm`, иллюстрирующим не только количество обработанных элементов, но и прошедшее и оставшееся время выполнения запроса. -- При работе с приложениями отслеживает устаревание токена авторизации и автоматически обновляет его через вызов функции, передаваемой пользователем. +- [OAuth-авторизация](#авторизация-через-oauth): при работе с приложениями отслеживает устаревание токена авторизации и автоматически обновляет его через вызов функции, передаваемой пользователем. ### Синхронный и асинхронный клиенты -- Наличие асинхронного клиента позволяет использовать библиотеку для написания веб-приложений (например, телеграм-ботов). +- Наличие [асинхронного клиента](#асинхронные-вызовы) позволяет использовать библиотеку для написания веб-приложений (например, телеграм-ботов). ### Нас используют - [Яндекс](https://github.com/leshchenko1979/fast_bitrix24/issues/159#issuecomment-1104539717) @@ -172,7 +172,7 @@ leads = await bx.get_all('crm.lead.list') ``` ### Авторизация через OAuth -Если требуется авторизация через OAuth, то при инициализации клиента `Bitrix()` необходимо передать в параметре `token_func` ссылку на асинхронную функцию, которая будет возвращать токен авторизации: +Если требуется авторизация через OAuth, то при инициализации клиента `Bitrix()` необходимо передать в параметре `webhook` ссылку на эндпойнт приложения, а в параметре `token_func` - ссылку на асинхронную функцию, которая будет возвращать токен авторизации: ```python from fast_bitrix24 import Bitrix import requests @@ -188,7 +188,7 @@ async def get_new_token() -> str: result = requests.get(oauth_url, timeout=10, params=params) return result.json()["access_token"] -bx = Bitrix(webhook, token_func=get_new_token) +bx = Bitrix(webhook=ENDPOINT_ADDRESS, token_func=get_new_token) ... ``` `token_func` будет вызываться каждый раз, когда необходимо получить впервые или обновить токен авторизации. @@ -257,7 +257,7 @@ with bx.slow(): bx = Bitrix( webhook, request_pool_size = 20, # по умолчанию - 50 - requests_per_second = 1.0, # по умолчанию - 1.0 + requests_per_second = 1.0, # по умолчанию - 2.0 batch_size = 20, # по умолчанию - 50 operating_time_limit = 100, # по умолчанию - 480 )