sinbadxiii / priceva-api-php
该包的最新版本(dev-master)没有提供许可证信息。
dev-master
2018-07-06 08:06 UTC
Requires
- php: >=5.5
This package is auto-updated.
Last update: 2024-09-12 21:41:44 UTC
README
Public API Priceva - 竞品监控价格跟踪解决方案 https://priceva.com。
入门指南
需求
要使用此组件,您至少需要
- Composer
- PHP >= 5.5
注意:对旧版PHP版本(下至7.0)的支持基于尽力而为的原则。
安装
Composer
$ php composer require sinbadxiii/priceva-api-php
或者按照以下方式创建composer.json文件
{
"require": {
"sinbadxiii/priceva-api-php": "dev-master"
}
}
使用
$api = new PricevaApi(['apiKey' => 'xxxxxxxxxxxxxx']);
//check access api
$api->ping()
//get all products
$api->productList();
//get one product
$api->getProduct($codeProduct);
//get all report
$api->reportList();
如果您想使用过滤器,您可以以两种方式设置条件。
第一种方式是创建一个包含过滤器字段的数组并将其传递给方法,例如
$api = new PricevaApi(['apiKey' => 'xxxxxxxxxxxxxx']);
$filter = [
'limit' => 10,
'brand_id' => 't'
];
$api->productList($filter);
...
$api->reportList($filter);
过滤器字段
$filter = [
'page' => 1;
'limit' => 100;
'category_id' => [];
'brand_id' => [];
'company_id' => "";
'region_id' => "";
'active' => 1;
'name' => "";
'articul' => "";
'client_code' => [];
];
第二种方式是使用过滤器构造函数createFilter()进行查询
$api = new PricevaApi(['apiKey' => 'xxxxxxxxxxxxxx']);
$result = $api->createFilter()
->setLimit(10)
->setPage(2)
->setCompany('b')
->execute() //the required method for assembling the filter
->productList();
...
$result = $api->createFilter()
->setLimit(10)
->setPage(2)
->setCompany('b')
->execute()
->reportList();
构造函数方法
- setPage($page);
- setLimit($limit);
- setCategory($category_id);
- setBrand($brand_id);
- setCompany($company_id);
- setRegion($region_id);
- setActive($active);
- setName($name);
- setSku($sku);
- setCodeProduct($client_code);