Download the PHP package business-ru/business-online-sdk-php without Composer

On this page you can find all versions of the php package business-ru/business-online-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of business-ru/business-online-sdk-php

Informations about the package business-online-sdk-php

Описание API:

https://api-online.class365.ru

Требования:

PHP 7.3 (и выше)

Установка:

В консоли с помощью Composer

  1. Установите пакетный менеджер Composer в папке вашего проекта, если до этого момента он еще не был установлен.

  2. В консоли выполните команду

Либо

  1. В файле composer.json своего проекта

Добавьте строку "business-ru/business-online-sdk-php": "*" в список зависимостей вашего проекта в файле composer.json

  1. Обновите зависимости проекта. В консоли перейдите в каталог, где лежит composer.json, и выполните команду:

Начало работы:

Создайте объект для работы с API:

При создании обьекта ему передаются параметры:

Запросы к API реализуются путем вызова методов у данного обьекта.

Запросы:

Запрос к API может быть выполнен двумя способами:

Request($method, $model, $params)

$method - Метод запроса

Поддерживаются 4 метода запроса:

Не все модели поддерживают все методы.

Подробнее о методах запроса можно узнать на сайте документации.

$model - Модель

Модель - требуется для указания типа данных для работы Все поддерживаемые модели можно узнать на сайте документации.

$params - Параметры запроса

Параметры запроса нужны для указания конкретного документа, сортировки, условий выборки и т.д. Возможные параметры можно узнать на сайте документации.

RequestAll($model, $params)

В отличии от предыдущего метода, данный метод выполняет только get запросы, но в ответе можно получить неограниченное количество данных (ограничение запросов в 250 записей не действует). Время выполнения данного метода может занимать длительное время. Если при создании данного объекта был передан параметр $sleepy равный true, то даже при превышении лимита запросов метод будет продолжать работу до тех пор, пока не получит все записи.

$model - Модель

Модель - требуется для указания типа данных для работы Все поддерживаемые модели можно узнать на сайте документации.

$params - Параметры запроса

Параметры запроса нужны для указания конкретного документа, сортировки, условий выборки и т.д. Возможные параметры можно узнать на сайте документации.

Работа с веб-хуками

Для работы с веб - хуками у созданного обьекта есть специальный метод - checkNotification()

При сравбатываниии веб - хука вы можете вызвать этот метод для проверки подлинности уведомления.

Метод возвращает true если событие прошло проверку, в противном случае вернет false

В случае если вам нужен функционал только проверки подлинности хуков, возможно не создавать обьект, а вызвать статичный метод __Client::check($app_id, $secret)__

Параметры:

Подробнее о веб - хуках можно узнать на сайте документации.

Уведомления

Для отправки уведомления пользователям используется метод sendNotification()

Метод принимает в качестве аргумента массив с параметрами уведомления, подробнее можно узнать на сайте документации.

Логирование

Библиотека использует стандарт PSR-3 для логгирования. Для включения логирования нужно у созданного ранее класса вызвать метод setLogger() и передать в качестве аргумента обьект, реализующий интерфейс

LoggerInterface пакета Psr\Log. Подробнее о PSR-3

Подготовленные запросы

Если вы хотите самостоятельно делать запросы - библиотека предоставляет возможность получать данные для этого. Для этого есть метод getPreparedUrl($method, $model, $params), где $method - метод запроса, $model - модель, $params - параметры запроса. Результатом работы метода является массив с ключом url - URL - адрес для выполенения запроса и data - данные, которые должны быть переданы в теле запроса.

Примеры

Ответ

В массиве ответа

Примечания

All versions of business-online-sdk-php with dependencies

PHP Build Version
Package Version
Requires php Version >=7.3
ext-curl Version *
ext-json Version *
psr/log Version ^1.1
psr/simple-cache Version ^1.0
psr/http-client Version ^1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package business-ru/business-online-sdk-php contains the following files

Loading the files please wait ....