Download the PHP package reutskiy-a/simple-api-bitrix24 without Composer

Simple REST API Bitrix24 client: OAuth 2.0, Webhook, flexible DB support, app installer, REST API Limit Handling Service

Клиент для REST API Bitrix24:

OAuth 2.0 (с автообновлением токенов), Webhook, поддержка всех популярных реляционных БД, менеджер установки локальных/тиражных приложений. Установка одного локального приложения на несколько порталов.

Встроенная обработка лимитов REST API

Installation

LANGUAGE:

Русский

English

Local/distributed app installation example:

Русский:

Содержание:

1. Быстрый старт: Webhook соединение

2. Соединение OAuth 2.0 (Локальное или Тиражное приложение)

   2.1. Подготовка базы данных для хранения токенов

   2.2. Создание объекта соединения OAuth 2.0

   2.3. Установка приложения

3. Смена соединения или клонирование объекта соединения

4. Логирование

   4.1. Debug логирование

   4.2. Рекомендуемый уровень логирования

5. Пакетные запросы

   5.1 Стандартный пакетный запрос

   5.2 Батч сервис

6. Встроенный сервис обработки лимитов REST API

1. Быстрый старт Webhook соединение

2. Соединение OAuth 2.0 (Локальное или Тиражное приложение)

Вы можете устанавливать одно и тоже локальное приложение на разные порталы. Только следите за корректностью client_id и client_secret при установке, иначе токены не обновятся, когда их время жизни закончится, и приложение выбросит исключение.

2.1 Подготовка базы данных для хранения токенов

Используйте любую удобную базу данных:

• PostgreSQL
• MySQL
• SQLite
• SQLServer

Создайте таблицу в базе данных. Пример запроса для MySQL:

2.2 Создание объекта соединения OAuth 2.0

Если надо динамически устанавливать соединение к порталу на входящий $_REQUEST['member_id'], то делайте так:

2.3 Установка приложения

3. Смена соединения или клонирование объекта соединения

Смена/установка соединения

Клонирование объекта соединения, если нужно работать одновременно с разными порталами Битрикс24.

4. Логирование

4.1 Debug логирование

При уровне логирования DEBUG, будут логироваться все запросы и ответы.

4.2 Рекомендуемый уровень логирования

Рекомендуемый уровень логирования WARNING. В логи попадут только ответы сервера Bitrix24 с ошибками, или исключения этого пакета SimpleApiBitrix24.

5. Пакетные запросы

5.1 Стандартный пакетный запрос

В один пакетный запрос можно завернуть до 50 запросов.

https://apidocs.bitrix24.ru/api-reference/how-to-call-rest-api/batch.html

5.2 Батч сервис

SimpleApiBitrix24\Services\Batch

Получение всех элементов сущности. Работает только с методами списочного типа.

Получение результата с учетом названий переданных ключей. Лимит: 50 упакованных запросов за один вызов.

6. Встроенный сервис обработки лимитов REST API

Подробней о лимитах rest api смотрите в официальной документации

https://apidocs.bitrix24.ru/limits.html

Этот пакет может обрабатывать ответы об ошибках лимитов REST API:

Пример обрабатываемых ошибок от сервера REST API:

Включается обработка ошибок конфигурацией объекта SimpleApiBitrix24\ApiClientSettings

По умолчанию обработка этих ошибок отключена, при включении укажите время ожидания в микросекундах. При получении ответа с одной из этих ошибок API Client будет делать повторный запрос через заданный интервал времени, не останавливая работу скрипта, делать это будет постоянно пока не завершится выполнение скрипта или не закончится время жизни приложения.

English

Client for Bitrix24 REST API:

OAuth 2.0 (with automatic token refresh), Webhook, support for all popular relational databases, manager for installing local/distributed applications. Installation of a single local application across multiple portals.

Table of Contents:

1. Quick Start: Webhook Connection

2. OAuth 2.0 Connection (Local or Edition App))

   2.1. Preparing the Database for Token Storage

   2.2. Creating an OAuth 2.0 Connection Object

   2.3. App Installation

3. Switching or Cloning the Connection

4. Logging

   4.1. Debug Logging

   4.2. Recommended Logging Level

5. Batch Requests

   5.1 Standard Batch Request

   5.2 Batch Service

6. Built-in REST API Limit Handling Service

1. Quick Start: Webhook Connection

2. OAuth 2.0 Connection (Local or Edition App

You can install the same local app on different portals. Ensure client_id and client_secret are correct during installation, otherwise tokens won’t refresh when they expire, and the app will throw an exception.

2.1 Preparing the Database for Token Storage

Use any database of your choice:

• PostgreSQL
• MySQL
• SQLite
• SQLServer

Create a table in the database. Example query for MySQL:

2.2 Creating an OAuth 2.0 Connection Object

To dynamically set the connection based on $_REQUEST['member_id'], do this:

2.3 App Installation

3. Switching or Cloning the Connection

Switching/setting a connection:

Cloning the connection object to work with multiple Bitrix24 portals simultaneously:

4. Logging

4.1 Debug Logging

At the DEBUG logging level, all requests and responses will be logged.

4.2 Recommended Logging Level

The recommended logging level is WARNING.

Only Bitrix24 server error responses or exceptions from this SimpleApiBitrix24 package will be logged.

5. Batch Requests

5.1 Standard Batch Request

Up to 50 requests can be included in a single batch request.

https://apidocs.bitrix24.com/api-reference/how-to-call-rest-api/batch.html

5.2 Batch Service

SimpleApiBitrix24\Services\Batch

Retrieving all entity items. Works only with list-type methods.

Retrieving results with specified key names. Limit: 50 batched requests per call.

6. Built-in REST API Limit Handling Service

For more details on REST API limits, refer to the official documentation:

https://apidocs.bitrix24.com/limits.html

This package can handle REST API limit error responses:

Examples of handled REST API server errors:

Error handling is enabled through the configuration of the SimpleApiBitrix24\ApiClientSettings object:

By default, handling of these errors is disabled. When enabled, specify the wait time in microseconds. Upon receiving one of these error responses, the API client will retry the request after the specified time interval without stopping the script's execution. It will continue doing so until the script completes or the application's lifetime expires.