README

将 Like4Card API 集成到 Laravel。

目录

• 安装
• 配置
• 可用的 API 方法
  • 获取商家余额
  • 分类
  • 按产品 ID 获取产品
  • 按分类获取产品
  • 获取所有订单
  • 获取订单详情
  • 创建新订单
• API 异常
  • 错误的凭证
    • 示例
  • 产品不可用
    • 示例
• 许可证

安装

通过 composer 安装

composer require codebuglab/laravel-like4card

在 config/app.php 文件中

'providers' => [
  ...
  CodeBugLab\Like4Card\Like4CardServiceProvider::class,
];

配置

将信息添加到 .env 文件

LIKE4CARD_DEVICE_ID=xxx
LIKE4CARD_EMAIL=xxx
LIKE4CARD_PASSWORD=xxx
LIKE4CARD_SECURITY_CODE=xxx
LIKE4CARD_LANG_ID=xxx

配置文件如下所示

[
  'device_id' => env('LIKE4CARD_DEVICE_ID', null),
  'email' => env('LIKE4CARD_EMAIL', null),
  'password' => env('LIKE4CARD_PASSWORD', null),
  'security_code' => env('LIKE4CARD_SECURITY_CODE', null),
  'lang_id' => env('LIKE4CARD_LANG_ID', 1)
]

可用的 API 方法

获取商家余额

帮助商家获取其余额和用户 ID 的操作。

$response = Like4Card::balance();

$response 是一个对象，包含以下参数

分类

获取此商家可用的所有分类的操作。

$response = Like4Card::categories();

$response 是一个 数组，包含以下参数

按产品 ID 获取产品

API 请求参数存在问题的示例：这将只获取第一个 ID

通过产品标识符数组获取所有可用的产品的操作。

$product_ids = [1, 2, 3]; // required products ids
$response = Like4Card::products($product_ids);

$response 是一个 数组。每个元素都是一个对象，包含以下参数

当没有找到产品时：$response 是一个包含错误信息的 字符串

每个可选字段都有

按分类获取产品

通过分类 ID 获取所有可用的产品的操作。

$category_id = 1;
$response = Like4Card::getProductsByCategoryId($category_id);

$response 是一个 数组。每个元素都是一个对象，包含以下参数。

当没有找到产品时：$response 是一个包含错误信息的 字符串

每个可选字段都有

获取所有订单

获取此商家创建的所有订单的操作。此 API 可以接收以下选项

// all options are not required
$options = [
  'page' => 1,
  'orderType' => 'asc',
  'from' => 1621327053,
  'to' => 1623998253
];
$response = Like4Card::orders($options);

$response 是一个对象，包含以下参数

获取订单详情

通过其 ID 获取单个订单详情的操作。

$order_id = 1;
$response = Like4Card::order($order_id);

$response 是一个对象，包含以下参数

每个序列对象都有

创建新订单

创建新订单的操作。此 API 可以接收以下参数

$product_id = 1;
$local_id = 123; // the id from your local orders table

$response = Like4Card::createOrder($product_id, $local_id);

$response 是一个对象，包含以下参数

API 异常

如果 API 响应 = 0，则服务会抛出异常。可能是以下异常之一

错误的凭证

当输入错误的 deviceId、username、password 或 securityCode 时抛出。

示例

  try {
    $response = Like4Card::balance();
  } catch (\CodeBugLab\Like4Card\Exceptions\WrongCredentialsException $ex) {
    echo $ex->getMessage(); // "Incorrect Login - invalid email or password"
  }

产品不可用

当没有找到给定 分类 ID 或 产品 ID 数组 的产品时抛出。

示例

  try {
    $data = Like4Card::getProductsByCategoryId(1);
  } catch (\CodeBugLab\Like4Card\Exceptions\ProductsNotFoundException $ex) {
    echo $ex->getMessage(); // "No available products"
  }

许可证

Laravel Like4Card 是一个在 MIT 许可证条款下分发的免费软件。