woothemes/woocommerce-api

此软件包已被弃用且不再维护。作者建议使用 automattic/woocommerce 软件包。

WooCommerce REST API 的客户端库

2.0.1 2015-07-13 21:19 UTC

This package is not auto-updated.

Last update: 2022-02-01 12:48:23 UTC


README

关于

PHP 对 WooCommerce REST API 的包装。通过此库可以轻松与 WooCommerce REST API 交互。

欢迎反馈和错误报告。

要求

PHP 5.2.x cURL WooCommerce 2.2 至少在商店上

入门

在 WP Admin > 您的资料下生成 API 凭证(消费者密钥 & 消费者密钥)。

设置库

require_once( 'lib/woocommerce-api.php' );

$options = array(
	'ssl_verify'      => false,
);

try {

	$client = new WC_API_Client( 'http://your-store-url.com', $consumer_key, $consumer_secret, $options );

} catch ( WC_API_Client_Exception $e ) {

	echo $e->getMessage() . PHP_EOL;
	echo $e->getCode() . PHP_EOL;

	if ( $e instanceof WC_API_Client_HTTP_Exception ) {

		print_r( $e->get_request() );
		print_r( $e->get_response() );
	}
}

选项

  • debug(默认 false) - 将其设置为 true 以将请求/响应信息添加到返回数据中。这对于解决错误特别有用。

  • return_as_array(默认 false) - 所有方法默认将数据作为 stdClass 返回,但您可以将此选项设置为 true 以返回关联数组。

  • validate_url(默认 false) - 将其设置为 true 以验证提供的 URL 是否有有效的、可解析的 WC API 索引,并且可选地强制 SSL。

  • timeout(默认 30) - 设置此值以控制请求的 HTTP 超时。

  • ssl_verify(默认 true) - 如果您不希望在每次请求中都执行 SSL 对等验证,请将其设置为 false

错误处理

当遇到错误时,会抛出异常,大多数将是 WC_API_Client_HTTP_Exception 的实例,该异常有两个额外的方法,get_request()get_response() - 这些方法返回请求和响应对象,以帮助进行调试。

方法

索引

  • $client->index->get() - 获取 API 索引

订单

  • $client->orders->get() - 获取订单列表
  • $client->orders->get( null, array( 'status' => 'completed' ) ) - 获取已完成订单的列表
  • $client->orders->get( $order_id ) - 获取单个订单

版权

版权所有 (c) 2013-2014 - Gerhard PotgieterMax Rice 及其他贡献者

许可

GPL3 许可证 下发布