README

LemonStand php-sdk 是一个简单易用的API接口，可以帮助您快速高效地开始使用。

授权

在您可以使用API之前，您需要从商店后端创建凭证。您可以按照以下步骤操作

1. 登录到您的商店的 /backend。
2. 在 设置 菜单标签下导航到 API 部分。
3. 添加一个新的API密钥，不要与任何人分享 secret 或 access token。

安装

将此行添加到您的 composer.json 文件中

{
  "require": {
    "lemonstand/php-sdk": "dev-master"
  }
}

要求

• PHP >=5.4，并安装了cURL扩展

使用方法

首先，您需要创建一个客户端。

$config = array(
    'shop' => 'store.lemonstand.com',
    'key' => 'hyfdNt0buc1ENxfec06YOGJQHh8bwqb3dMuBHMXI',
    'secret' => 'hyfdNt0buc1ENxfec06YOGJQHh8bwqb3dMuBHMXI',
    'token' => 'hyfdNt0buc1ENxfec06YOGJQHh8bwqb3dMuBHMXI'
);

$client= new \LemonStand\sdk\Client($config);

然后，您可以调用API的特定端点。

$products = $client->get('/products');

要向API发送数据，请将第二个参数作为数组传递。

$data = array(
    "in_stock_amount" => 500,
    "is_on_sale" => 1,
    "sale_price_or_discount" => 39.99
);

$res = $client->patch('/product/1', $data);

// Check to see if the request returned successfully
if (!$res['success']) {
        throw new \Exception($res["error"]["message"]);
}

echo var_dump($res["body"]);

###响应 每个请求返回一个包含以下数据结构的响应数组

array(
	"data" => array,
	"headers" => array,
	"status" => integer,
	"success" => boolean,
	"error" => array(
		"raw" => array, 
		"message" => string
	),
);

data - 这是响应的主体。如果您对一个单一资源发出请求，输出将是一个数组。如果您对一个集合发出请求，这将是一个数组数组。
headers - 包含响应返回的头部的关联数组。
status - 包含响应代码的整数。例如 200。
success - 一个布尔值，用于指示请求是否成功。可能的值是 true 或 false。
error - 在成功请求的情况下，这将是一个 null。否则，raw 值将包含从服务器发送的错误对象，而 message 将包含一个可读的 string。如果请求的 success 是 false，您可以将 error["message"] 显示给最终用户。

可用方法

• get
• put
• post
• patch
• head
• delete

许可证

Apache 2.0