Download the PHP package targethunter/max-php-sdk without Composer

On this page you can find all versions of the php package targethunter/max-php-sdk. 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 targethunter/max-php-sdk

Informations about the package max-php-sdk

MAX PHP SDK

PHP SDK для работы с API мессенджера MAX. Этот пакет предоставляет удобный интерфейс для взаимодействия с MAX Bot API.

Установка

Установите пакет через Composer:

Требования

Быстрый старт

Инициализация клиента

Получение информации о боте

Модули API

SDK разделен на несколько модулей, для удобства использования. Модули реализованы так же, как в официальном API MAX.

1. Модуль Bots (Боты)

Управление информацией о боте.

Примеры:

2. Модуль Messages (Сообщения)

Работа с сообщениями.

Примеры:

3. Модуль Chats (Чаты)

Управление чатами и участниками.

Примеры:

4. Модуль Upload (Загрузка файлов)

Загрузка файлов в MAX.

Примеры:

5. Модуль Subscriptions (Подписки)

Управление webhook подписками.

Примеры:

Обработка ошибок

SDK автоматически обрабатывает ошибки от API MAX и преобразует их в читаемый формат. Все методы могут выбрасывать исключения MAXHttpException при ошибках сети или API.

Автоматическая обработка ошибок

SDK автоматически:

Типы ошибок

SDK обрабатывает различные форматы ошибок от MAX API:

Если ответ не в формате JSON, SDK вернет сырое тело ответа.

Конфигурация

Базовый URL API

По умолчанию SDK использует базовый URL API: https://platform-api.max.ru/

Кастомный HTTP клиент

Вы можете создать собственный HTTP клиент и передать его в конструктор MAXRequest:

Кастомизация через наследование

Вы можете унаследоваться от MAXRequest и переопределить нужные методы:

Кастомный URL API

Кастомный класс исключений

Метод createException() — фабрика для создания исключений. Переопределите его, чтобы SDK бросал ваши доменные исключения вместо MAXHttpException:

Логика парсинга ответа API (извлечение человекочитаемого сообщения из JSON) остаётся в SDK — вы получаете готовое сообщение в параметре $message.

Полный пример использования

Лицензия

MIT License

Поддержка

Если у вас есть вопросы или проблемы, создайте issue в репозитории проекта.

All versions of max-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4|^8
guzzlehttp/guzzle Version ^7.5
ext-json Version *
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 targethunter/max-php-sdk contains the following files

Loading the files please wait ...