Download the PHP package stealth/jsonrpc-client without Composer
On this page you can find all versions of the php package stealth/jsonrpc-client. 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 jsonrpc-client
JSON-RPC Client (Laravel 5, Lumen 5)
Описание
JsonRpc клиент - реализация клиента для JsonRpc-сервера. Работает по спецификации JsonRpc 2.0. Протестирован и работает с оригинальным сервером JsonRpc от Tochka.
Установка
Laravel
composer require tochka-developers/jsonrpc-client-
Если планируете использовать автоматическую генерацию прокси-клиента - необходимо подклюдчить сервис-провайдер в в конфигурации приложения (
config/app.php): - Опубликуйте конфигурацию:
Lumen
composer require tochka-developers/jsonrpc-client- Скопируйте конфигурацию из пакета (
vendor/tochka-developers/jsonrpc/config/jsonrpc.php) в проект (config/jsonrpc.php) -
Подключите конфигурацию в
bootstrap/app.php: -
Включите поддержку фасадов в
bootstrap/app.php: - Если планируете использовать автоматическую генерацию прокси-клиента - зарегистрируйте сервис-провайдер
Tochka\JsonRpcClient\ServiceProviderвbootstrap/app.php:
Использование
Настройка
Конфигурация находится в файле app/jsonrpcclient.php.
В данном файле прописываются настройки для всех JsonRpc-подключений.
clientName- Имя клиента. Данное имя будет подставляться в ID-всех запросов в виде префикса. Позволяет идентифицировать сервис.default- подключение по умолчанию. Должно содержать имя подключения.connections- массив подключений. Каждое подключение должно иметь уникальный ключ (название подключения).
Настройки подключений:
url- URL-адрес (или IP) для подключения к JsonRpc-серверу. Должен содержать полный путь к точке входа (например: https://api.jsonrpc.com/v1/jsonrpc).auth- настройки аутентификации. Доступно два вида аутентификации:auth.headerToken- аутентификации с помощью токена в заголовке. Для настройки внутри используются параметры:auth.headerToken.name- имя заголовкаauth.headerToken.key- передаваемый в заголовке ключ
auth.http- HTTP-аутентификацияauth.http.scheme- схема аутентификации. Возможные варианты:basic,digest,ntlm,gss,any(включает все схемы - basic, digest, ntlm, gss),safe(включает только безопасные схемы - digest, ntlm, gss)auth.headerToken.username- имя пользователяauth.headerToken.password- пароль
key- токен авторизации. Если на сервере не используется авторизация по заголовку - можно не указывать.clientClass- класс, который используется в качестве прокси-класса. Необходимо указывать полное наименование (с пространством имен). Используется при автоматической генерации прокси-класса.Вызовы без прокси-класса
Вызов метода JsonRpc:
Если необходимо использовать конкретное подключение, используется метод get:
Если не указано конкретное подключение - используется подключение по умолчанию.
По умолчанию клиент передает все переданные в метод параметры в виде индексированного массива.
Если JsonRpc-сервер требует передачи именнованных параметров - воспользуйтесь методом call:
Клиент поддерживает вызов нескольких удаленных методов через один запрос:
В указанном примере в переменных $resultFoo, $resultBar и $resultSome будет пустой класс Tochka\JsonRpcClient\Response,
пока не будет вызван метод execute. После этого будет осуществлен один запрос на JsonRpc-сервер, переменные
заполнятся вернувшимися результатами с сервера.
Клиент поддерживает кеширование результатов с помощью метода cache:
При таком вызове результаты будут закешированы на 10 минут, и последующих вызовах этого метода с такими же параметрами - запрос на сервер не будет посылаться, результат будет сразу получаться из кеша. Естественно, результаты кешируются только для успешных вызовов.
Также кеширование поддерживается и для нескольких вызовов:
Учтите, что кешироваться будет только тот метод, перед которым был вызван cache.
Генерация прокси-класса
Прокси-класс - это наследник JsonRpcClient, который содержит информацию обо всех доступных методах JsonRpc-сервера, а также сам делает маппинг параметров, переданных в метод, в виде ассоциативного массива. Если сервер умеет возвращать SMD-схему, то такой класс может быть сгенерирован автоматически.
Для генерации класса воспользуйтесь командой:
Для успешной генерации должно выполняться несколько условий:
- JsonRpc-сервер должын поддерживать возврат SMD-схемы (при передаче GET-параметра ?smd)
- Желательно, чтобы в качестве сервера использовался
tochka-developers/jsonrpc. Данный пакет умеет возвращать расширенную информацию для более точной генерации прокси-класса - Должен быть прописан URL-адрес JsonRpc-сервера
- Должно быть указано полное имя прокси-класса. Путь к файлу класса будет сгенерирован автоматически исходя из
пространства имен и настроек
composer. - Папка, в которой будет находиться прокси-класс, должна иметь иметь права на запись.
Если все указанные условия выполняются - то будет создан прокси-класс на указанное соединение. Для обновления прокси-класса (в случае обновления методов сервера) - повторно вызовите указанную команду. Если необходимо сгенерировать классы для всех указанных соединений - вызовите указанную команду без указания соединения:
Вызовы через прокси-класс
Прокси-класс уже содержит информацию об используемом соединении, поэтому метод get вызывать не нужно.
Кроме того, прокси-класс сам реализует маппинг параметров, передаваемых в метод, в ассоциативный массив для
передачи на JsonRpc-сервер. Реализация маппинга происходит только если JsonRpc-сервер использует ассоциативные
параметры.
Примеры вызовов:
