README

描述

类 Apiki_Buscape_API 被创建，用于帮助开发使用 BuscaPé API 提供的 web 服务。

如何工作？

Apiki_Buscape_API 类 预先配置 您的应用程序以与 BuscaPé API 集成，这意味着它 简化了集成并加速了应用程序的开发。

如何使用？

在您的应用程序中为它定义一个目录。

mkdir buscape-php

克隆存储库

git clone https://github.com/buscapedev/buscape-php.git buscape-php

实例化类。使用创建的实例调用类的方法。

require_once 'Apiki_Buscape_API.php';

$applicationID  = '564771466d477a4458664d3d';
$sourceID       = '';

$objBuscaPeApi = new Apiki_Buscape_API( $applicationID, $sourceID );
$objBuscaPeApi->findCategoryList();

有关更多信息，请访问BuscaPé 开发者指南

Lomadee 代码创建方法

string Apiki_Buscape_API::createSource( array $args )

仅用于应用程序与 Lomadee 集成的服务。

在集成流程中，应用程序使用此服务为希望使用的 Publisher 创建 sourceId（代码）。在此服务中所需的参数由 自己的 Lomadee 通知应用程序。

在沙箱测试环境中，参数值可以是虚构的，因为在此环境中此服务将为 Developer 的测试返回相同的 sourceId。

所有必需的参数都包含在一个数组中，并将其传递给方法，它们是：

• sourceName 代码名称。
• publisherId Publisher ID。
• siteId Publisher 选定的站点 ID。
• campaignList 以逗号分隔的战役 ID 列表。
• token 用于验证请求的令牌。

可用的查询方法

string Apiki_Buscape_API::findCategoryList( array $args )

此方法搜索类别，允许您显示与类别相关的信息。您可以通过仅提供类别 ID 来获取类别、产品或优惠。

所有必需的参数都包含在一个数组中，并将其传递给方法，它们是：

• categoryId 类别 ID。
• keyword 在类别中搜索的关键词。
• callback 如果使用 JSON 作为返回，则要执行返回函数。

如果没有提供任何参数，则函数将默认返回 ID 为 0 的根类别列表。

string Apiki_Buscape_API::findOfferList( array $args , boolean $lomadee )

此方法搜索优惠列表。您可以通过提供产品 ID 来获取优惠列表。

所有必需的参数都包含在一个数组中，并将其传递给方法，它们是：

• categoryId 类别 ID。
• keyword 在类别中搜索的关键词。
• productId 产品 ID。
• barcode 产品条形码。
• offerId 优惠 ID。
• 纬度 地理坐标。
• 经度 地理坐标。
• 半径 地理坐标。
• callback 如果使用 JSON 作为返回，则要执行返回函数。

$lomadee参数是一个布尔值，用来指示是否使用Lomadee API，默认值为false。

至少需要提供一个搜索参数给函数以获取返回值。参数categoryId和keyword可以一起使用。

string Apiki_Buscape_API::findProductList(array $args, boolean $lomadee)

此方法允许您通过最终分类ID或一组关键词或两者结合来搜索独特的产品列表。所有必要的搜索参数都应在传递给方法的数组中提供，它们是

• categoryId 类别 ID。
• keyword 在类别中搜索的关键词。
• callback 如果使用 JSON 作为返回，则要执行返回函数。

至少需要提供一个参数，即categoryID或keyword，才能使此函数正常运行。这两个参数也可以同时使用。也就是说，我们可以在特定类别中搜索一个关键词。

$lomadee参数是一个布尔值，用来指示是否使用Lomadee API，默认值为false。

string Apiki_Buscape_API::topProducts(array $args)

此方法返回BuscaPé上最受欢迎的产品。所有必要的搜索参数都应在传递给方法的数组中提供，它们是

• callback 如果使用 JSON 作为返回，则要执行返回函数。

string Apiki_Buscape_API::viewProductDetails(array $args)

此函数返回特定产品的技术细节。所有必要的搜索参数都应在传递给方法的数组中提供，它们是

• productId 产品ID (必填)。
• callback 当使用json作为返回值时，要执行的反函数。

string Apiki_Buscape_API::viewSellerDetails(array $args)

此函数返回商店/公司的详细信息，如地址、联系电话等。所有必要的搜索参数都应在传递给方法的数组中提供，它们是

• sellerId 商店/公司ID (必填)。
• callback 如果使用 JSON 作为返回，则要执行返回函数。

string Apiki_Buscape_API::viewUserRatings(array $args)

此方法返回用户对特定产品的评价。所有必要的搜索参数都应在传递给方法的数组中提供，它们是

• productId 产品ID (必填)。
• callback 如果使用 JSON 作为返回，则要执行返回函数。

获取器、设置器和辅助方法

string Apiki_Buscape_API::getApplicationId()

返回应用程序ID。

另见 Apiki_Buscape_API::setApplicationId(string $applicationId)

string Apiki_Buscape_API::getCountryCode()

返回国家代码。

另见 Apiki_Buscape_API::setCountryCode(string $countryCode)

string Apiki_Buscape_API::getEnvironment()

返回集成环境（bws为生产环境，sandbox为测试环境）。

另见 Apiki_Buscape_API::setSandbox()

字符串 Apiki_Buscape_API::getFormat()

返回返回格式（xml 或 json）。

另请参阅 Apiki_Buscape_API::setFormat( string $format )

字符串 Apiki_Buscape_API::getSourceId()

返回 Source ID。

另请参阅 Apiki_Buscape_API::setSourceId( string $sourceId )

void Apiki_Buscape_API::setApplicationId( string $applicationId )

定义应用程序 ID。

• string $applicationId 在 BuscaPé 上注册的应用程序 ID。

要获取应用程序 ID，您需要进行 注册

另请参阅 Apiki_Buscape_API::getApplicationId()

void Apiki_Buscape_API::setCountryCode( string $countryCode )

定义国家代码。

• string _$countryCode 国家代码，可以是以下之一
  • AR 代表阿根廷
  • BR 代表巴西
  • CL 代表智利
  • CO 代表哥伦比亚
  • MX 代表墨西哥
  • PE 代表秘鲁
  • VE 代表委内瑞拉

另请参阅 Apiki_Buscape_API::getCountryCode()

void Apiki_Buscape_API::setFormat( string $format )

定义返回格式。

• string $format 返回格式，可以是 xml 或 json

另请参阅 Apiki_Buscape_API::getFormat()

void Apiki_Buscape_API::setSandbox( void )

定义集成是在沙盒环境还是生产环境中进行。

另请参阅 Apiki_Buscape_API::getEnvironment()

void Apiki_Buscape_API::setSourceId( string $sourceId )

定义 sourceId

• string $sourceId sourceId

另请参阅 Apiki_Buscape_API::getSourceId()