README

简介

欢迎来到沃尔玛开放API PHP客户端，这是一个用于与 沃尔玛开放API 交互的 Composer 包。

此库由 Guzzle 6 支持，因此需要 PHP >= 5.5.0 才能运行。

提供了广泛的 PHPUnit 测试，构建由 Travis-CI 处理，测试代码覆盖率由 Coveralls.io 计算。

贡献

如果您发现任何错误或对改进有想法，请随时向项目的 问题跟踪器 提交工单。

欢迎提交拉取请求，但请记住将它们提交到 develop 分支。任何提交到 master 分支的PR都将被拒绝。

安装

Composer

如果您本地系统上还没有Composer，请先安装它

curl -sS https://getcomposer.org/installer | php

手动安装

创建一个 composer.json 文件，并在 "require" 部分添加一个条目

{
    "require": {
        "gadoma/walmart-api-php-client": "^1.0"
    }
}

然后运行以下命令

php composer.phar install

Composer安装

或者，除了上述方法外，您还可以直接运行以下命令

php composer.phar require gadoma/walmart-api-php-client:^1.0

用法

沃尔玛API密钥

为了使用沃尔玛开放API，您需要获取一个API密钥。您可以通过注册一个 沃尔玛开发者账户 来获取。

基本用法

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

//API credentials
$apiKey = 'yourWalmartApiKey';

//Basic components used by the Services
$httpClient        = new \GuzzleHttp\Client();
$errorHandler      = new \WalmartApiClient\Exception\Handler\ApiExceptionHandler();
$transportService  = new \WalmartApiClient\Http\TransportService($httpClient, $errorHandler, $apiUrl);
$entityFactory     = new \WalmartApiClient\Factory\EntityFactory();
$collectionFactory = new \WalmartApiClient\Factory\CollectionFactory();

//Actual Services you will use for interacting with the API
$productService  = new \WalmartApiClient\Service\ProductService($transportService, $entityFactory, $collectionFactory);
$offerService    = new \WalmartApiClient\Service\OfferService($transportService, $entityFactory, $collectionFactory);
$reviewService   = new \WalmartApiClient\Service\ReviewService($transportService, $entityFactory, $collectionFactory);
$taxonomyService = new \WalmartApiClient\Service\TaxonomyService($transportService, $entityFactory, $collectionFactory);

LinkShare发布者ID

您可以为URL跟踪/归因目的提供您的 LinkShare Publisher Id。这是可选的，您可以在 沃尔玛联盟网站 上了解更多关于这个主题的信息。要使用此库中的 LinkShare Publisher Id，只需在创建基本组件的过程中将其传递给 TransportService 构造函数，如下所示

$apiKey = 'yourWalmartApiKey';
$linkSharePublisherId = 'yourId';

$httpClient        = new \GuzzleHttp\Client();
$errorHandler      = new \WalmartApiClient\Exception\Handler\ApiExceptionHandler();
$transportService  = new \WalmartApiClient\Http\TransportService($httpClient, $errorHandler, $apiUrl, $linkSharePublisherId);

功能

每个可用的服务都是对沃尔玛开放API的一个或多个服务的包装。可用的方法声明和描述可以在 服务接口 中找到。每个方法返回单个特定实体（例如产品）或实体集合（例如类别集合）。

产品服务

集成

• 产品查找API
• 搜索API
• 产品推荐API
• 浏览后产品API
• 趋势API

可用方法

• getById
• getByUpc
• getByIds
• getBySearch
• getAllBySearch
• getPostbrowsedById
• getRecommendedById
• getTrending

优惠服务

集成

• 特殊馈送API

可用方法

• getVod
• getPreorder
• getBestsellers
• getRollback
• getClearance
• getSpecialbuy

评论服务

集成

• 评论API

可用方法

• getReviews

商店服务

集成

• 商店定位API

可用方法

• getStoresByCoordinates
• getStoresByCity
• getStoresByZip

分类法服务

集成

• 分类法API

可用方法

• 获取类别