alekseon/yuppim-api-v1-php-sdk

Yuppim Api PHP SDK

1.0.1 2020-09-24 14:53 UTC

This package is auto-updated.

Last update: 2024-09-09 22:21:07 UTC


README

这是Yuppim PHP API v1的官方PHP SDK。

入门指南

为了使用此库,您至少需要PHP 7.0版本。

使用Yuppim PHP SDK有两种方法

使用Composer

您需要使用Composer下载Yuppim PHP SDK

composer require alekseon/yuppim-api-v1-php-sdk

如果您不熟悉Composer,请在这里了解它这里

使用示例

在提供的示例中,您将看到如何初始化所选API及其可用操作

  • 通过ID获取单个产品
  • 获取产品数组
// get single product
$productApi = (new \YuppimApi\Yuppim('your-token'))->product();
$product = $productApi->get($productId);

// get all of products, deafult limit is 100 products in one response
$productsApi = (new \YuppimApi\Yuppim('your-token'))->products();
$products = $productsApi->get();

// get products with pagination
$productsApi = (new \YuppimApi\Yuppim('your-token'))->products();
$productsApi->setLimit($limit);
$productsApi->setPage($page);
$products = $productsApi->get();

// get products filtered
$productsApi = (new \YuppimApi\Yuppim('your-token'))->products();
$productsApi->addFilter($field, $operator, $value);
$products = $productsApi->get();

产品过滤器

允许过滤的字段有

  • 名称
  • 名称或标识符
  • 目录号
  • 价格生效日期
  • 添加日期
  • 修改日期
  • 生产商
  • 供应商

支持的运算符有

  • "="
  • ">"
  • "<"
  • "!="
  • "IN"
  • "CONTAINS"
  • "STARTS WITH"
  • "MATCH"

注意:并非所有运算符都适用于所有引用字段。

// get products filtered example
$productsApi = (new \YuppimApi\Yuppim('your-token'))->products();
$productsApi->addFilter('Data_dodania', '>', '2020-01-01 00:00:00');
$productsApi->addFilter('Dostawca', 'IN', ['Dostawca_X', 'Dostawca_Y']);
$product = $productsApi->get();

支持和反馈

如果您发现任何错误,请直接在这里的GitHub提交问题。