PHPackages stealth/jsonrpc-client - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. stealth/jsonrpc-client ActiveLibrary[API Development](/categories/api) stealth/jsonrpc-client ====================== JsonRpc Client for Laravel v2.0.2(7y ago)011MITPHPPHP >=5.6.4 Since Jul 24Pushed 7y ago1 watchersCompare [ Source](https://github.com/truestealth/jsonrpc-client)[ Packagist](https://packagist.org/packages/stealth/jsonrpc-client)[ RSS](/packages/stealth-jsonrpc-client/feed)WikiDiscussions master Synced 3d ago READMEChangelog (3)Dependencies (1)Versions (16)Used By (0) JSON-RPC Client (Laravel 5, Lumen 5) ==================================== [](#json-rpc-client-laravel-5-lumen-5) Описание -------- [](#описание) JsonRpc клиент - реализация клиента для JsonRpc-сервера. Работает по спецификации JsonRpc 2.0. Протестирован и работает с оригинальным сервером JsonRpc от Tochka. Установка --------- [](#установка) ### Laravel [](#laravel) 1. `composer require tochka-developers/jsonrpc-client` 2. Если планируете использовать автоматическую генерацию прокси-клиента - необходимо подклюдчить сервис-провайдер в в конфигурации приложения (`config/app.php`): ``` 'providers' => [ //... Tochka\JsonRpcClient\ServiceProvider::class, ], ``` 3. Опубликуйте конфигурацию: ``` php artisan vendor:publish --provider="Tochka\JsonRpcClient\ServiceProvider" ``` ### Lumen [](#lumen) 1. `composer require tochka-developers/jsonrpc-client` 2. Скопируйте конфигурацию из пакета (`vendor/tochka-developers/jsonrpc/config/jsonrpc.php`) в проект (`config/jsonrpc.php`) 3. Подключите конфигурацию в `bootstrap/app.php`: ``` $app->configure('jsonrpc'); ``` 4. Включите поддержку фасадов в `bootstrap/app.php`: ``` $app->withFacades(); ``` 5. Если планируете использовать автоматическую генерацию прокси-клиента - зарегистрируйте сервис-провайдер `Tochka\JsonRpcClient\ServiceProvider` в `bootstrap/app.php`: ``` $app->register(Tochka\JsonRpcClient\ServiceProvider::class); ``` Использование ------------- [](#использование) ### Настройка [](#настройка) Конфигурация находится в файле `app/jsonrpcclient.php`. В данном файле прописываются настройки для всех JsonRpc-подключений. - `clientName` - Имя клиента. Данное имя будет подставляться в ID-всех запросов в виде префикса. Позволяет идентифицировать сервис. - `default` - подключение по умолчанию. Должно содержать имя подключения. - `connections` - массив подключений. Каждое подключение должно иметь уникальный ключ (название подключения). Настройки подключений: - `url` - URL-адрес (или IP) для подключения к 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: ``` use Tochka\JsonRpcClient\Client; //.... $result = Client::fooBar('Some text'); ``` Если необходимо использовать конкретное подключение, используется метод `get`: ``` $result = Client::get('api')->fooBar('Some text'); ``` Если не указано конкретное подключение - используется подключение по умолчанию. По умолчанию клиент передает все переданные в метод параметры в виде индексированного массива. Если JsonRpc-сервер требует передачи именнованных параметров - воспользуйтесь методом `call`: ``` $result = Client::get('api')->call('fooBar', ['text' => 'Some text']); ``` Клиент поддерживает вызов нескольких удаленных методов через один запрос: ``` $api = Client::get('api')->batch(); $resultFoo = $api->foo('params'); $resultBar = $api->bar(123); $resultSome = $api->call('someMethod', ['param1' => 1, 'param2' => true]); $api->execute(); ``` В указанном примере в переменных $resultFoo, $resultBar и $resultSome будет пустой класс `Tochka\JsonRpcClient\Response`, пока не будет вызван метод `execute`. После этого будет осуществлен один запрос на JsonRpc-сервер, переменные заполнятся вернувшимися результатами с сервера. Клиент поддерживает кеширование результатов с помощью метода `cache`: ``` $result = Client::get('api')->cache(10)->fooBar('Some text'); ``` При таком вызове результаты будут закешированы на 10 минут, и последующих вызовах этого метода с такими же параметрами - запрос на сервер не будет посылаться, результат будет сразу получаться из кеша. Естественно, результаты кешируются только для успешных вызовов. Также кеширование поддерживается и для нескольких вызовов: ``` $api = Client::get('api')->batch(); $resultFoo = $api->cache(10)->foo('params'); $resultBar = $api->bar(123); $resultSome = $api->cache(60)->call('someMethod', ['param1' => 1, 'param2' => true]); $api->execute(); ``` Учтите, что кешироваться будет только тот метод, перед которым был вызван `cache`. ### Генерация прокси-класса [](#генерация-прокси-класса) Прокси-класс - это наследник JsonRpcClient, который содержит информацию обо всех доступных методах JsonRpc-сервера, а также сам делает маппинг параметров, переданных в метод, в виде ассоциативного массива. Если сервер умеет возвращать SMD-схему, то такой класс может быть сгенерирован автоматически. Для генерации класса воспользуйтесь командой: ``` php artisan jsonrpc:generateClient connection ``` Для успешной генерации должно выполняться несколько условий: 1. JsonRpc-сервер должын поддерживать возврат SMD-схемы (при передаче GET-параметра ?smd) 2. Желательно, чтобы в качестве сервера использовался `tochka-developers/jsonrpc`. Данный пакет умеет возвращать расширенную информацию для более точной генерации прокси-класса 3. Должен быть прописан URL-адрес JsonRpc-сервера 4. Должно быть указано полное имя прокси-класса. Путь к файлу класса будет сгенерирован автоматически исходя из пространства имен и настроек `composer`. 5. Папка, в которой будет находиться прокси-класс, должна иметь иметь права на запись. Если все указанные условия выполняются - то будет создан прокси-класс на указанное соединение. Для обновления прокси-класса (в случае обновления методов сервера) - повторно вызовите указанную команду. Если необходимо сгенерировать классы для всех указанных соединений - вызовите указанную команду без указания соединения: ``` php artisan jsonrpc:generateClient ``` ### Вызовы через прокси-класс [](#вызовы-через-прокси-класс) Прокси-класс уже содержит информацию об используемом соединении, поэтому метод `get` вызывать не нужно. Кроме того, прокси-класс сам реализует маппинг параметров, передаваемых в метод, в ассоциативный массив для передачи на JsonRpc-сервер. Реализация маппинга происходит только если JsonRpc-сервер использует ассоциативные параметры. Примеры вызовов: ``` // Single call $result = Api::fooBar('Some text'); // Multiple call $api = Api::batch(); $resultFoo = $api->cache(10)->foo('params'); $resultBar = $api->bar(123); $resultSome = $api->cache(60)->someMethod(1, true); $api->execute(); ``` ### Health Score 27 — LowBetter than 49% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity5 Limited adoption so far Community7 Small or concentrated contributor base Maturity66 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~31 days Recently: every ~13 days Total 15 Last Release 2778d ago Major Versions v1.1.3 → v2.0.02018-10-05 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/4082902?v=4)[truestealth](/maintainers/truestealth)[@truestealth](https://github.com/truestealth) --- Top Contributors [![lexxksb](https://avatars.githubusercontent.com/u/622791?v=4)](https://github.com/lexxksb "lexxksb (5 commits)") ### Embed Badge ![Health badge](/badges/stealth-jsonrpc-client/health.svg) ``` [![Health](https://phpackages.com/badges/stealth-jsonrpc-client/health.svg)](https://phpackages.com/packages/stealth-jsonrpc-client) ``` ### Alternatives [ycs77/laravel-newebpay A library of connecting newebpay's API service. 319.1k](/packages/ycs77-laravel-newebpay) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)