s25/prices-client

Client for parts' prices' services

2.4.0 2024-05-29 11:54 UTC

Requires

• php: ^8.0
• ext-json: *
• guzzlehttp/guzzle: ^6.5||^7.0

Requires (Dev)

• phpunit/phpunit: ^9.5

proprietary

README

S25\PricesApiClient\Client - класс клиента API, включает методы вида requestApiMethod, возвращающие инстансы запросов, реализующие интерфейс S25\PricesApiClient\Contract\ApiMethodRequestContract.

Интерфейсы запросов наследуют из базового интерфейса методы perform() и performAsync() для синхронного и асинхронного выполнения соответственно.

В комментарии интерфейса запроса есть информация об:

• обязательных сеттерах, вызываемых перед выполнением запроса,
• формате возвращаемых данных.

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

Входные и выходные данные

Все методы API-запросов следуют следующим соглашениям:

Методы setRawNumber(s)? принимают номер/массив номеров без форматирования, только [0-9A-Z].

Методы вида set{Param}s всегда идут в паре с add{Param} для попунктного заполнения параметров.

Возвращаемые цены всегда за упаковку. Лучшие цены рассчитываются исходя из отношения цена за уп./кол-во в уп., но в результат попадают только цены за упаковку.

Пример инициализации клиента API

Инстанцируем клиент, запрос, указываем необходимые параметры запроса.

use S25\PricesApiClient\Client;

$client = new Client('http://service.url', 'SHOP-API-KEY');

$request = $client->requestBunchBestPrices()
    ->setBrandSlug('suzuki')
    ->addRawNumber('RAWPARTNUMBER1')
    ->addRawNumber('RAWPARTNUMBER2')
    ->addRawNumber('RAWPARTNUMBER3')
    ->addCurrencyCode('CUR');

Далее, получение данных может быть как синхронным:

use S25\PricesApiClient\Contracts\Request;

/** @var Request\BunchBestPricesRequestContract $request */

$bestPricesResponse = $request->perform();

var_dump($bestPricesResponse);

, так и асинхронным:

use S25\PricesApiClient\Contracts\Request;

/** @var Request\BunchBestPricesRequestContract $request */

$request->performAsync()
    ->then(static function ($bestPricesResponse) {
        var_dump($bestPricesResponse);
    })
    ->wait();

Генераторы

Дополнительны метод iterate класса PaginateAllRequestContract позволяет последовательно получить все цены для всех товаров в цикле foreach:

use S25\PricesApiClient\Contracts\Request;

/** @var Request\PaginateAllRequestContract $request */

foreach ($request->iterate() as [
    'brandSlug' => $brandSlug,
    'rawNumber' => $rawNumber,
    'number' => $number,
    'name' => $name,
    'prices' => $prices,
]) {
    foreach ($prices as $supplierSlug => $supplierPrices) {
        foreach ($supplierPrices as $currencyCode => [$price, $perPack]) {
            // ... just DO IT! 
        }
    }
}