ДАННЫЙ ПАКЕТ ЯВЛЯЕТСЯ УСТАРЕВШИМ И НЕ РЕКОМЕНДУЕТСЯ К ИСПОЛЬЗОВАНИЮ! В СКОРОМ ВРЕМЕНИ ОН БУДЕТ УДАЛЁН!

PHP клиент для работы с B2B API проекта Avtoraport

Данный пакет является реализацией "клиента" для работы с B2B API, значительно упрощающим работу с последним.

Особенности

К особенностям можно отнести следующие моменты:

• Удобная работа с настройками - достаточно передать в конструктор массив, переопределяющий значения из конфигурационного файла "по умолчанию";
• Режим "эмуляции" реальных запросов к B2B API - достаточно указать класс тестового драйвера HTTP клиента - и возвращаемые значения будут браться из заранее подготовленных шаблонов в формате json (как и "боевые" ответы). Более подробно об этом можете посмотреть в тестах;
• Поддержка версионности протоколов B2B API "из коробки" - для своей версии используется свой класс клиента, что позволяет при необходимости осуществлять поддержку работы с разными версиями B2B API более тривиально;
• Корректный phpdoc каждого метода, реализующего обращение к B2B API;
• Легко расширяемый - новые методы обращения к B2B API обавляются очень просто.

Установка

Выполняем в терминале:

$ composer require avtoraport/b2b-api-php

Тестирование

Выполняем в терминале:

$ composer test

Начало работы

Для того, чтобы начать пользоваться данным пакетом достаточно:

<?php

require __DIR__ . '/vendor/autoload.php';

$client = new Avtoraport\B2BApi\B2BApiV1Client([
    'client'   => [
        // Домен пользователя
        'domain' => '%имя_вашего_домена%',
        // Имя пользователя
        'username' => '%имя_вашего_пользователя%',
        // Пароль пользователя
        'password' => '%пароль_вашего_пользователя%',
        // UID типа отчета, используемый по умолчанию
        'default_report_type_uid' => '%uid_типа_отчета_по_умолчанию%',
    ],
]);

$client->userInfo(); // Вернется информация о вашей учетной записи

Более подробную информацию о том, какие параметры вы можете использовать можете посмотреть в файле b2b-api-client.php.

Реализованные на данный момент методы

Версия API: 1.0

Обратная связь и поддержка

Если вы обнаружите какие-либо проблемы при работе с данный клиентом, либо у вас появятся пожелания либо необходимость в каком-либо дополнительном методе то, пожалуйста, создайте соответствующий issue в данном репозитории.