README

概述

A2Reviews 客户端 API 允许您构建应用程序、扩展或插件以从 A2reviews APP 获取评论。包括将评论添加到商店的产品中。它用于通过 API 导入和导出评论。这是由 A2Reviews, Inc. 构建和发展官方包。

要求

PHP >= 7.2
Composer
Guzzle

安装

执行以下命令以获取包

composer require eosvn/a2reviews-client-api

用法

创建 A2Reviews 客户端的实例，然后使用它来访问 A2Reviews 客户端 API。

<?php

require_once __DIR__ . "/vendor/autoload.php";

$a2Review = new EOSVN\A2ReviewsClient\A2ReviewsClient([
    'api_key' => '{A2Review_API_Key}',
    'api_secret' => '{A2Review_API_Secret}',
]);

示例

以下示例仅使用一些参数作为演示。有关详细参数，请访问我们的文档。

产品评论

评论 API，允许获取产品或所有产品的评论。使其能够在不同的平台上部署。

获取产品评论

$response = $a2Review->review->getProductReviews([
    'handle' => '{product_handle}',
    'limit' => 2 // Number record per page
]);

获取功能评论

$response = $a2Review->review->getFeatureReviews([
    'limit' => 2
]);

获取黑名单评论

$response = $a2Review->review->getBlockListReviews([
    'limit' => 2
]);

获取块评论

$response = $a2Review->review->getBlockReviews([
    'limit' => 2
]);

将评论写入产品

$response = $a2Review->review->addReviewToProduct([
    'handle' => '{product_handle}',
    'review' => [
        'rating' => 4,
        'title' => 'Package title review.',
        'author' => 'Author name',
        'email' => 'author_email@gmail.com',
        'content' => 'Package content review.'
    ]
]);

更新评论

$response = $a2Review->review->updateReview([
    'id' => '{review_id}',
    'handle' => '{product_handle}',
    'review' => [
        'rating' => 2,
        'title' => 'Package title review (update).',
        'author' => 'Author name',
        'email' => 'author_email@gmail.com',
        'content' => 'Package content review.'
    ]
]);

更新图片评论

$response = $a2Review->review->updateImageReview([
    'id' => '{review_id}',
    'handle' => '{product_handle}',
    'image' => [
        'attachment' => '{image data base64}',
        'filename' => '{filename}'
    ]
]);

客户端站点设置

客户端站点的 API，允许获取全局设置和语言设置。

获取全局设置

$response = $a2Review->setting->getGlobalSettings();

获取评论语言

$response = $a2Review->setting->getReviewLanguages();

获取问题答案语言

$response = $a2Review->setting->getQuestionAnswerLanguages();

获取常用语言

$response = $a2Review->setting->getCommonLanguages();

请求后，使用以下方式获取数据

$response->getData();

文档

A2Reviews - 官方客户端 API 文档

更新日志

请参阅更新日志了解最近更改的信息。

安全性

如果您在 a2reviews-client-api 中发现安全漏洞，请通过 A2Reviews, Inc 的 info@a2rev.com 发送电子邮件。所有安全漏洞都将得到及时解决。

鸣谢

许可协议

Laravel 框架是开源软件，许可协议为 MIT 协议。

eosvn / a2reviews-client-api

维护者

详细信息