ntoklo/ntokloapi-php

ntoklo推荐引擎的API连接器

1.0.5 2015-09-30 13:33 UTC

This package is not auto-updated.

Last update: 2024-09-28 17:28:11 UTC


README

版本:1.0.5 稳定版

此库允许您连接到ntoklo API并创建自己的应用程序,获取令牌和结果。API的完整文档可以在nToklo开发网站上找到:https://docs.ntoklo.com

安装

Composer

$ composer require ntoklo/ntokloapi-php

使用

您可以在文档中查看如何使用此库。

包含require路径到autoload.php,并实例化一个新的NtokloApi类,并传递ntoklo API密钥和密钥。

require "vendor/autoload.php";

$api = new NtokloApi('nToklo API key', 'nToklo API secret');

示例

事件

事件API允许客户发送ntoklo用户活动。有关事件更多信息,请点击这里

$api->postEvent( $array );

添加产品

将新产品添加到ntoklo API。有关发布产品的更多信息,请点击这里

$api->postProduct( $array );

获取产品

通过ID获取产品。有关通过ID获取产品的更多信息,请点击这里

$api->getProduct( $productId );

推荐

推荐API允许客户根据用户历史和产品属性检索推荐。有关推荐的更多信息,请点击这里

$api->recommendations( $userId, $productId, $scope, $value );

图表

图表API允许客户检索最受欢迎的产品列表。图表表示滚动的时间窗口(每日或每周),可以通过产品属性进行范围限制,并可以通过操作进行过滤。有关图表的更多信息,请点击这里

$api->chart( $timestamp, $scope, $value, $action, $tw, $maxItems );

添加到黑名单

添加到黑名单。有关将产品添加到黑名单的更多信息,请点击这里

$api->addBlacklist($productId);

从黑名单中移除

从黑名单中移除。有关从黑名单中移除产品的更多信息,请点击这里

$api->removeBlacklist($productId);

获取黑名单产品

获取所有黑名单产品。有关获取黑名单产品的更多信息,请点击这里

$api->fetchBlacklist();

功能

以下是此API连接器提供的功能列表

  • postEvent($date);
  • postProduct($data_product);
  • getProduct($productId);
  • recommendations($userId = null, $productId = null, $scope = null, $value = null);
  • chart($timestamp = null, $scope = null, $value = null, $action = null, $tw = null, $maxItems = null);
  • addBlacklist($productId);
  • removeBlacklist($productId);
  • fetchBlacklist();

作者

许可

此库根据Apache 2.0许可证授权。有关更多详细信息,请参阅LICENSE文件。

版权

版权所有 2015 nToklo Ltd.