netvlies/bolopenapi-bundle

该软件包最新版本(dev-master)的许可证信息不可用。

Bol.com Open Api 是一个 RESTful API,您可以使用它与 Bol.com 网上商店目录进行通信。此捆绑包使您能够在 Symfony 2 应用程序中将此 API 作为服务使用变得非常简单。

dev-master 2012-04-05 08:09 UTC

This package is not auto-updated.

Last update: 2024-09-22 03:54:20 UTC


README

Build Status

Bol.com Open Api 是一个 RESTful API,您可以使用它与 Bol.com 网上商店目录进行通信。此捆绑包将 Bol OpenAPi PHP SDK 注册到依赖注入容器中,这使得您能够在 Symfony 2 应用程序中将此 API 作为服务使用变得非常简单。

您需要开发者密钥才能使用此 API。您可以通过在 Bol.com 开发者中心 注册 来获取一个。

注意 此捆绑包处于开发中,尚不能在生产环境中使用。

许可证

此捆绑包在 MIT 许可证下发布。完整的许可证请参见此处

Resources/meta/LICENSE

安装

下载

将以下内容添加到您的 deps 文件中

[Buzz]
    git=git://github.com/kriswallsmith/Buzz.git
    target=/Buzz

[bol-openapi-php-sdk]
    git=git://github.com/netvlies/bol-openapi-php-sdk.git

[NetvliesBolOpenApiBundle]
    git=git://github.com/netvlies/NetvliesBolOpenApiBundle.git
    target=/bundles/Netvlies/Bundle/BolOpenApiBundle

然后,运行 vendors 脚本

$ php bin/vendors install

注册命名空间

在您的 app/autoload.php 文件中注册 Netvlies 命名空间

$loader->registerNamespaces(array(
    // ...
    'Netvlies\\Bundle'          => __DIR__.'/../vendor/bundles',
    'Buzz'                      => __DIR__.'/../vendor/Buzz/lib',
    'BolOpenApi'                => __DIR__.'/../vendor/bol-openapi-php-sdk/src',
    // ...
));

初始化捆绑包

app/AppKernel.php 中注册捆绑包

public function registerBundles()
{
    return array(
        // ...
        new Netvlies\Bundle\BolOpenApiBundle\NetvliesBolOpenApiBundle(),
        // ...
    );
}

配置

下一步是配置 app/config/config.yml 中的捆绑包

netvlies_bol_open_api:
    access_key:         YOUR_ACCESS_KEY
    secret_access_key:  YOUR_SECRET_ACCESS_KEY

使用方法

API 现在作为服务容器中的服务可用

class WelcomeController extends Controller
{
    public function indexAction()
    {
        // ...
        $bolApi = $this->get('netvlies_bol_open_api.api');
        // ...
    }
}

搜索产品/分类

searchresults 操作通过提供关键字或 ISBN/EAN 返回产品信息。此操作具有过滤和分页选项。

class WelcomeController extends Controller
{
    public function indexAction()
    {
        // ...
        $term = 'PHP';
        $options = array(
            // Set your options here
        );
        $bolApi = $this->get('netvlies_bol_open_api.api');
        $searchResult = $bolApi->searchResults($term, $options);
        // ...
    }
}

列出产品/分类

listresults 操作根据列表类型和分类返回各种产品列表。分类基于 ID,可以通过分类列表请求获取。

有关可用列表类型的更多信息,请参阅 文档

class WelcomeController extends Controller
{
    public function indexAction()
    {
        // ...
        $type = 'toplist_default';
        $categoryIdAndRefinements = '87';
        $options = array(
            // Set your options here
        );
        $bolApi = $this->get('netvlies_bol_open_api.api');
        $listResult = $bolApi->listResults($type, $categoryIdAndRefinements, $options);
        // ...
    }
}

获取产品信息

products 操作获取产品的详细信息。

class WelcomeController extends Controller
{
    public function indexAction()
    {
        // ...
        $productId = '1002004011800815';
        $bolApi = $this->get('netvlies_bol_open_api.api');
        $productResponse = $bolApi->products($productId);
        // ...
    }
}

文档

请参阅 Bol OpenApi PHP SDK 获取更多示例和配置设置。有关 API 的更多文档,请访问 Bol.com 开发者中心

测试

从您的 Symfony 2 应用程序的 projectfolder 运行测试

phpunit -c app/ vendor/bundles/Netvlies/Bundle/BolOpenApiBundle/