Download the PHP package phenogram/gateway-bindings without Composer

On this page you can find all versions of the php package phenogram/gateway-bindings. 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?

Informations about the package gateway-bindings

English · Русский

Phenogram Gateway Bindings

CI Последняя стабильная версия Версия PHP

Строго типизированные PHP-биндинги для Telegram Gateway API.

Пакет помогает отправлять коды подтверждения через Telegram. В нём есть:

Пакет не выбирает HTTP-библиотеку за ваше приложение. Реализуйте ClientInterface или адаптируйте проверенный пример на cURL.

Требования

Установка

Запуск примеров из репозитория

Для команд с примерами ниже нужен клон репозитория. Подготовьте клон перед запуском:

Первый запуск без сети

Запустите полный пример. Он использует локальный ответ. Для него не нужны токен, сеть и платная операция API.

Ожидаемый результат:

Также можно имитировать отправку сообщения:

Ожидаемый результат:

Отправка реального сообщения

[!WARNING] Реальный запрос может списать средства со счёта Telegram Gateway. До запуска прочитайте раздел Правила тарификации.

Задайте токен и номер получателя. Используйте формат E.164.

Пример вызывает sendVerificationMessage напрямую. Если вы хотите применить этот клиент в приложении, скопируйте examples/CurlClient.php и замените пространство имён.

Правила тарификации

checkSendAbility — необязательный метод. Это не бесплатная пробная проверка.

Прямой вызов sendVerificationMessage тарифицируется по плану Gateway. Telegram возвращает средства, если сообщение не выполнило условия доставки в пределах заданного ttl. Актуальные правила приведены в официальной документации Gateway API.

Публичный API

Метод Назначение Результат
sendVerificationMessage(...) Отправляет код подтверждения. RequestStatusInterface
checkSendAbility($phoneNumber) Проверяет возможность отправки на номер. Этот вызов может списать средства. RequestStatusInterface
checkVerificationStatus($requestId, $code) Получает статус запроса и при необходимости проверяет код. RequestStatusInterface
revokeVerificationMessage($requestId) Просит Telegram отозвать сообщение. bool

Все параметры и значения статусов описаны в русском руководстве по API.

Контракт HTTP-клиента

Класс Api передаёт имя метода и сериализованный массив данных вашему клиенту:

Верните Response с точной структурой ответа Gateway API:

Gateway API не возвращает поля Bot API description, error_code и parameters. Интерфейс и поля конструктора из версии 1.0 сохранены для совместимости исходного кода. В новых реализациях ответа используйте GatewayResponseInterface и его поле error.

Правила транспорта и обработки ошибок описаны в русском руководстве по клиенту.

Ошибки

Если Telegram вернул ok: false, класс Api выбрасывает ResponseException. Исключение принимает любую реализацию ResponseInterface.

Некорректный успешный ответ вызывает UnexpectedValueException. Транспорт может использовать RuntimeException для ошибок сети, HTTP и JSON.

Типизированные результаты

RequestStatusInterface содержит:

Если Telegram не вернул необязательное поле, его значение равно null. Сериализатор отклоняет ответ без обязательного поля или с неверным типом.

Документация и примеры

Материал English Русский
API и тарификация docs/en/api.md docs/ru/api.md
HTTP-клиенты и ошибки docs/en/client.md docs/ru/client.md

Исполняемые примеры:

Запустите все примеры без доступа к сети:

Разработка

Установите основные зависимости и изолированные инструменты контроля качества:

Запустите все локальные проверки:

Команда проверяет метаданные Composer, запускает PHPUnit и все примеры без сети, выполняет PHPStan на максимальном уровне и проверяет стиль кода.

Безопасность

Сообщайте об уязвимости через закрытый канал связи с сопровождающим. Не публикуйте учётные данные и персональные данные в открытой задаче. Подробности приведены в политике безопасности.

Участие в разработке

Прочитайте CONTRIBUTING.md. Не используйте сеть в тестах. Обновляйте английскую и русскую документацию в одном изменении.

Лицензия

MIT


All versions of gateway-bindings with dependencies

PHP Build Version
Package Version
Requires php Version ^8.4
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 phenogram/gateway-bindings contains the following files

Loading the files please wait ...