roncodes/woocommerce-rest-api-client

WooCommerce REST API客户端库

2.0.1 2015-07-13 21:19 UTC

This package is not auto-updated.

Last update: 2024-09-23 16:02:33 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许可证下发布