Download the PHP package reutskiy-a/simple-api-bitrix24 without Composer
On this page you can find all versions of the php package reutskiy-a/simple-api-bitrix24. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package simple-api-bitrix24
Simple REST API Bitrix24 client: OAuth 2.0, Webhook, flexible DB support, app installer.
Клиент для REST API Bitrix24:
OAuth 2.0 (с автообновлением токенов), Webhook, поддержка всех популярных реляционных БД, менеджер установки локальных/тиражных приложений. Установка одного локального приложения на несколько порталов.
Installation
LANGUAGE:
Русский
English
Русский:
Содержание:
-
Быстрый старт: Webhook соединение
-
Соединение OAuth 2.0 (Локальное или Тиражное приложение)
2.1. Подготовка базы данных для хранения токенов
2.2. Создание объекта соединения OAuth 2.0
2.3. Установка приложения
-
Смена соединения или клонирование объекта соединения
-
Логирование
4.1. Debug логирование
4.2. Рекомендуемый уровень логирования
-
Пакетные запросы
5.1 Стандартный пакетный запрос
5.2 Сервис списочных методов для получения всех элементов
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. Логирование
Используйте любой пакет для логирования реализующий PSR-3: Logger Interface.
В примере будет пакет monolog/monolog.
4.1 Debug логирование
При уровне логирования DEBUG, будут логироваться все запросы и ответы.
4.2 Рекомендуемый уровень логирования
Рекомендуемый уровень логирования WARNING. В логи попадут только ответы сервера Bitrix24 с ошибками, или исключения этого пакета SimpleApiBitrix24.
5. Пакетные запросы
5.1 Стандартный пакетный запрос
Про все ограничения запросов в официальной документации https://apidocs.bitrix24.ru/limits.html
В один пакетный запрос можно завернуть до 50 запросов.
5.2 Сервис списочных методов для получения всех элементов
SimpleApiBitrix24\Services\Batch::getAll() работает только с методами списочного типа. Возвращает все элементы указанной сущости.
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:
-
Quick Start: Webhook Connection
-
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
-
Switching or Cloning the Connection
-
Logging
4.1. Debug Logging
4.2. Recommended Logging Level
-
Batch Requests
5.1 Standard Batch Request
5.2 Service for List Methods to Retrieve All Items
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
Use any PSR-3 Logger Interface compatible logging package.
The example below uses monolog/monolog.
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
See all request limits in the official documentation: https://apidocs.bitrix24.com/limits.html
Up to 50 requests can be included in a single batch request.
5.2 Service for List Methods to Retrieve All Items
SimpleApiBitrix24\Services\Batch::getAll() works only with list-type methods and retrieves all items of the specified entity.
