README

安装

您可以通过 composer 安装此包

composer require combindma/yotpo-api

您可以使用以下命令发布配置文件

php artisan vendor:publish --provider="Combindma\YotpoApi\YotpoApiServiceProvider" --tag="yotpo-config"

这是已发布配置文件的内容

return [
    /*
    * Enable or disable Yotpo api. Useful for local development when runing tests.
    */
    'api_enabled' => env('YOTPO_API_ENABLED', false),

    /*
   * Enable or disable Yotpo Loyalty. Useful for local development when runing tests.
   */
    'loyalty_enabled' => env('YOTPO_LOYALTY_ENABLED', false),

    /*
    * Core API V3 Credentials
    */
    'app_key' => env('YOTPO_APP_KEY'),
    'secret_key' => env('YOTPO_SECRET_KEY'),

    /*
    * Loyalty & Referrals API Credentials
    */
    'loyalty_api_key' => env('LOYALTY_API_KEY'),
    'loyalty_guid_key' => env('LOYALTY_GUID_KEY'),

    /*
     * CDNs
     * */
    'loyalty_js_sdk_url' => env('LOYALTY_JS_SDK_URL'),
    'loyalty_modules_loader_url' => env('LOYALTY_MODULES_LOADER_URL'),

    /*
     * Refer link used by Loyalty Program
     * */
    'refer_link' => 'http://rwrd.io',

    /*
     * Default currency code you want to use. Make sure to have the same in your Yotpo Loyalty admin: https://loyalty.yotpo.com/general-settings
     * */
    'currency' => env('YOTPO_DEFAULT_CURRENCY', 'MAD'),

    /*
    * Default country code you want to use. This is important for API requests when submitting the phone number
    * */
    'country' => env('YOTPO_DEFAULT_COUNTRY', 'MA')
];

用法

• 您应该在 https://yotpo.com 上创建一个免费账户，并在 .env 文件中添加您的凭证
• 您必须将 Combindma\YotpoApi\Traits\YotpoCustomer 添加到用户模型中或实现自己的。只需确保有相同的结构（相同的数组键）。
• 您必须将 Combindma\YotpoApi\Traits\YotpoPurchase 添加到订单模型中或实现自己的。只需确保有相同的结构（相同的数组键）。

有关更多文档

• 忠诚度 API 文档：https://loyaltyapi.yotpo.com/reference
• 核心 API V3 文档：https://core-api.yotpo.com/reference

使用示例：在忠诚度计划中创建一个客户

use Combindma\YotpoApi\Facades\YotpoApi;

//yotpoApiData is implemented in Combindma\YotpoApi\Traits\YotpoCustomer. You can create yours.
YotpoApi::createOrUpdateLoyaltyCustomer($user->yotpoApiData());

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近更改的详细信息。

致谢

• Combind
• 所有贡献者

许可

MIT 许可证 (MIT)。有关更多信息，请参阅 许可文件。