README

一个用于Clyde API的PHP库。有关完整文档，请访问https://api.joinclyde.com/docs。

安装

$ composer require "clyde-sdk"

入门

该框架支持所有Clyde API端点。有关API的完整信息，请访问docs。

所有端点都需要有效的clientKey和clientSecret。

// Instantiate a Clyde object. First paramater is the key,
// second parameter the secret, and last is isLive (defaults to false).
$clyde = new Clyde('ck_your_key', 'sk_your_secret', true); 

在测试时，将isLive设置为false（类构造函数的第三个参数），并使用测试密钥而不是实时密钥。这允许您在不创建活跃客户或合同的情况下进行测试。完成测试后，将isLive设置为true并使用您的实时密钥。请注意，在此点所有合同订单都被视为实时和有效。

方法

所有方法都将返回一个关联数组。有关每个调用返回的数组结构的完整文档。

创建产品

创建一个产品。请参阅文档了解可用的属性。

$newProduct = $clyde.createProduct($productOptions);

更新产品

更新您的产品。第一个参数是产品的SKU；第二个参数是一个包含产品更新的关联数组。请参阅文档了解完整的选项和返回结构。

$updatedProduct = $clyde.updateProduct($sku, $productOptions);

获取单个产品

获取单个产品。产品SKU是第一个参数；可选的第二个参数是IP地址，用于地理敏感查询。

$product = $clyde.getProduct($sku);

获取多个产品

获取与您的商店关联的所有产品。可选地，您可以通过传递包含page键和/或SKU数组的关联数组opts来检索特定页面或SKU子集，以及用于地理敏感查询的IP地址。

$products = $clyde.getProducts($optionalOpts, $optionalIp);

获取产品的合同

获取某个产品的所有可用合同。产品SKU是第一个参数；可选的第二个参数是IP地址，用于地理敏感查询。

$contracts = $clyde.getContractsForProduct($sku, $optionalIp);

创建订单

创建一个订单。使用此命令创建合同销售或报告可保产品以供以后销售。第一个参数是订单的内部ID；第二个参数是一个包含订单参数的关联数组。请参阅我们的文档了解可用的选项。

$order = $clyde.createOrder($id, $orderOpts);

获取订单

获取已提交的订单。系统中的订单ID是第一个也是唯一的参数。

$order = $clyde.getOrder($id);

取消订单

取消您已提交的订单。使用此命令取消所有合同销售，或从我们的系统中删除与订单关联的所有行项目。系统中的订单ID是第一个也是唯一的参数。

$order = $clyde.cancelOrder($id);

获取合同销售

获取以前销售的合同销售。原始销售返回的ID是第一个也是唯一的参数。

$contractSale = $clyde.getContractSale($clydeId);

取消合同销售

取消以前销售的合同销售。原始销售返回的ID是第一个也是唯一的参数。

$contractSale = $clyde.cancelContractSale($clydeId);

错误处理

当发生错误时，clyde-sdk将抛出该错误。使用try / catch来处理错误。

try {
  $newProduct = $clyde.createProduct($productOptions);
} catch(Exception $e) {
  // Handle the exception
}

许可证

MIT