nodasoft / abcp_api_client
Rest клиент для ABCP API
Requires
- php: >=5.3.10
README
Официальный сайт платформы abcp
Установка
Установка с использованием composer и командной строки:
php composer.phar require nodasoft/abcp_api_client:1.2
Установка через конфигурационный файл composer.json:
"require": { "nodasoft/abcp_api_client": "3.4" }
Установка через git:
скопировать репозиторий в проект и включить автозагрузчик:
require_once '__autoload.php';
Использование
Перед началом использования клиента необходимо получить данные для авторизации у менеджера платформы abcp
Ключ пользователя (userKey), e-mail для которого активирована услуга и пароль для доступа к службе.
Инициализация клиента:
$tecDocRestClient = new \NS\ABCPApi\RestApiClients\TecDoc(); $tecDocRestClient->setUserKey('your_userKey) ->setUserLogin('your_email') ->setUserPsw('your_password');
Установка произвольного адреса:
$tecDocRestClient->setHost
Получение списка производителей:
//$carType - тип автомобиля. 0 - все, 1 - легковые, 2- грузовые, 3-малотонажные //$motorcyclesFilter - фильтрация по мотоциклам. 0 - все, 1 - только автомобили, 2 - только мотоциклы $manufacturers = $tecDocRestClient->getManufacturers($carType, $motorcyclesFilter);
Получение списка моделей:
//$manufacturerId - идентификатор производителя $models = $tecDocRestClient->getModels($manufacturerId);
Получение списка модификаций:
//$manufacturerId - идентификатор производителя //$modelId - идентификатор модели $modifications = $tecDocRestClient->getModifications($manufacturerId, $modelId);
Получение дерева групп деталей:
//$modificationId - идентификатор модификации $tree = $tecDocRestClient->getModelVariant($modificationId);
Получение списка деталей по группе:
//$modificationId - идентификатор модификации //$categoryId - идентификатор категории $articles = $tecDocRestClient->getArticles($modificationId, $categoryId);
Получение списка деталей по группе, упрощенный:
//$modificationId - идентификатор модификации //$categoryId - идентификатор категории $articles = $tecDocRestClient->getArticlesSimplified($modificationId, $categoryId);
Получение детализированной информации по детали:
//$articleId - идентификатор детали $article = $tecDocRestClient->getArticle($articleId);
Получение списка деталей по применимости:
//$articleId - идентификатор детали $adaptability = $tecDocRestClient->getAdaptability($articleId);
Получение списка деталей аналогов:
//$articleId - идентификатор детали //$analogType - тип аналогов, описан классом \NS\TecDocSite\Common\AnalogTypes $analogs = $tecDocRestClient->getAnalogs($number, $analogType);