wic/woocommerce-api

WooCommerce REST API 的客户端库

v0.3.1 2015-10-23 09:10 UTC

This package is not auto-updated.

Last update: 2024-09-25 16:32:57 UTC


README

关于

PHP 对 WooCommerce REST API 的包装器。使用此库轻松与 WooCommerce REST API 交互。

欢迎反馈和错误报告,我们将尽快修复。

安装

通过 Composer

$ composer require wic/woocommerce-api

要求

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

入门指南

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

设置库

use WIC/Client;

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

try {

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

} catch ( ClientException $e ) {

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

	if ( $e instanceof ClientHTTPException ) {

		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

错误处理

遇到错误时抛出异常,大多数将是 ClientHTTPException 的实例,该异常有两个额外的方法,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-2015 - Web In ColorGerhard PotgieterMax Rice 和其他贡献者

许可

GPL3 许可证 下发布