README

一个易于使用的PHP包，用于在Laravel中与Shopify的API进行通信。

##安装 ####在 composer.json 中要求 rocket-code/shopify

在您的 "require" 对象中添加 "rocket-code/shopify"。对于空白Laravel安装，它将看起来像这样

Laravel 5，使用 "rocket-code/shopify": "~2.0"。对于Laravel 4，使用 "rocket-code/shopify": "~1.0"。

	"require": {
		"laravel/framework": "4.2.*",
		"rocket-code/shopify": "~1.0"
	}

####添加服务提供者在 app/config/app.php 中，将 RocketCode\Shopify\ShopifyServiceProvider 添加到 providers 数组末尾。

##设置 ####通过 App::make() 获取 API 类的实例。

$sh = App::make('ShopifyAPI');

####加载API凭据只需传递一个包含以下键（和填充的值）的数组来准备。不需要一次性传递所有值；您可以多次调用 setup() 方法；它只接受以下4个键，并且如果已经设置，将覆盖值。

$sh->setup(['API_KEY' => '', 'API_SECRET' => '', 'SHOP_DOMAIN' => '', 'ACCESS_TOKEN' => '']);

#####快捷方式：将设置数组作为 App::make() 的第二个参数传递

$sh = App::make('ShopifyAPI', ['API_KEY' => '', 'API_SECRET' => '', 'SHOP_DOMAIN' => '', 'ACCESS_TOKEN' => '']);

这就完成了！您现在可以开始进行API调用了。

##找到安装URL在至少设置了 SHOP_DOMAIN & API_KEY 后，调用 installURL() 并传递一个包含权限（应用的Scope）的数组

$sh->installURL(['permissions' => array('write_orders', 'write_products')]);

您也可以根据Shopify API文档中的描述传递一个重定向URL

$sh->installURL(['permissions' => array('write_orders', 'write_products'), 'redirect' => 'http://myapp.com/success']);

##认证/获取OAuth访问令牌为了进行认证请求，必须将访问令牌作为每个请求的头部传递。此包将自动为您完成，但您必须首先在每个商店（作为用户安装它时）认证您的应用程序，并保存访问令牌。

$code = Input::get('code');
$sh = App::make('ShopifyAPI', ['API_KEY' => '', 'API_SECRET' => '', 'SHOP_DOMAIN' => '']);

try
{
	$accessToken = $sh->getAccessToken($code);
}
catch (Exception $e)
{
	echo '<pre>Error: ' . $e->getMessage() . '</pre>';
}

// Save $accessToken

try
{
	$verify = $sh->verifyRequest(Input::all());
	if ($verify)
	{
		$code = Input::get('code');
		$accessToken = $sh->getAccessToken($code);
	}
	else
	{
		// Issue with data
	}

}
catch (Exception $e)
{
	echo '<pre>Error: ' . $e->getMessage() . '</pre>';
}


	

$verify = $sh->verifyRequest(Input::all(), TRUE);

API包装器不区分私有和公共应用程序。为了与私有应用程序一起使用，按照常规设置一切，将OAuth访问令牌替换为私有应用程序的密码。

##调用API一旦设置完成，只需将所需数据传递给 call() 方法。

$result = $sh->call($args);

####call() 参数以下列出的参数允许您设置API调用所需的值以及覆盖其他默认值。

• 方法：用于API调用的HTTP方法。不同的端点需要不同的方法。
  • 默认：GET
• URL：要调用的API端点的URL。
  • 默认：/（不是一个实际的端点）
• 头部：要发送的额外头部数组
  • 默认：空数组。自动发送的头部包括
    • Accept
    • Content-Type
    • charset
    • X-Shopify-Access-Token
• 字符集：如有必要，更改字符集
  • 默认：UTF-8
• 数据：与调用一起发送的数据数组。例如，$args['DATA'] = array('product' => $product); 对于一个 /admin/products.json 产品创建 POST。
  • 默认：空数组
• RETURNARRAY：设置为TRUE以以数组格式返回数据。FALSE将返回一个stdClass对象。
  • 默认：FALSE
• ALLDATA：如果您希望与API数据一起返回所有错误和cURL信息（适用于调试），请将其设置为TRUE。数据将在$result->_ERROR和$result->_INFO或$result['_ERROR']和$result['_INFO']中可用，具体取决于您是否以对象或数组的形式返回。建议在生产中设置为FALSE。
  • 默认：FALSE
• FAILONERROR：传递给cURL的CURLOPT_FAILONERROR设置的值。TRUE将导致API包装器在HTTP代码大于等于400时抛出异常。FALSE与ALLDATA设置为TRUE结合将为您提供更多调试信息。
  • 默认：TRUE

##一些示例假设已经如上所述设置了$sh。

####列出产品

try
{

	$call = $sh->call(['URL' => 'products.json', 'METHOD' => 'GET', 'DATA' => ['limit' => 5, 'published_status' => 'any']]);
}
catch (Exception $e)
{
	$call = $e->getMessage();
}

echo '<pre>';
var_dump($call);
echo '</pre>';

$call将包含一个包含products的stdClass对象或一个异常错误消息。

####从Laravel视图中创建片段

$testData = ['name' => 'Foo', 'location' => 'Bar'];
$view = (string) View::make('snippet', $testData);

$themeID = 12345678;

try
{
	$call = $sh->call(['URL' => '/admin/themes/' . $themeID . '/assets.json', 'METHOD' => 'PUT', 'DATA' => ['asset' => ['key' => 'snippets/test.liquid', 'value' => $view] ] ]);
}
catch (Exception $e)
{
	$call = $e->getMessage();
}

echo '<pre>';
var_dump($call);
echo '</pre>';

####在多个商店上执行操作setup()方法使更改当前商店变得简单。

$apiKey = '123';
$apiSecret = '456';

$sh = App::make('ShopifyAPI', ['API_KEY' => $apiKey, 'API_SECRET' => $apiSecret]);

$shops = array(
		'my-shop.myshopify.com'		=> 'abc',
		'your-shop.myshopify.com'	=> 'def',
		'another.myshopify.com'		=> 'ghi'
		);
		
foreach($shops as $domain => $access)
{
	$sh->setup(['SHOP_DOMAIN' => $domain, 'ACCESS_TOKEN'' => $access]);
	// $sh->call(), etc

}