README

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

## 安装 #### 在 composer.json 中要求 garmanio/shopify

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

对于 Laravel 5，使用 "garmanio/shopify": "~3.0"

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

## 设置 Up 首先，使用 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() 并传递一个权限（应用程序的作用域）数组

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

您还可以根据 Shopify API 文档中的描述通过 redirect_uri 参数传递一个重定向 URL

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

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

一旦用户访问安装 URL 并点击安装按钮，他们将被重定向回您的应用程序，其中包含查询字符串中的数据。

在至少设置 SHOP_DOMAIN、API_KEY 和 API_SECRET 之后，使用 URL 中传递的代码调用 getAccessToken()。Laravel 使得这一点变得非常简单

$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

#### 验证 OAuth 数据 Shopify 返回一个散列值以验证数据。为了验证（在调用 getAccessToken() 之前推荐），请使用 verifyRequest()。

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>';
}

verifyRequest() 在数据有效时返回 TRUE，否则返回 FALSE。在两种情况下会抛出异常：如果 Shopify 和您的服务器生成的时间戳相差超过一小时，或者如果传递的参数不是数组或 URL 编码的键/值字符串。

如果您想跳过时间戳检查（不建议除非您无法纠正服务器的时钟），可以将 TRUE 作为 verifyRequest() 的第二个参数传递，并将忽略时间戳。

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

私有应用程序

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

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

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

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

METHOD：用于API调用的HTTP方法。不同的端点需要不同的方法。
- 默认：GET
URL：要调用的API端点的URL。
- 默认：/（不是实际端点）
HEADERS：要发送的额外头信息数组
- 默认：空的array()。自动发送的头信息包括
  - Accept
  - Content-Type
  - charset
  - X-Shopify-Access-Token
CHARSET：如有必要，更改字符集
- 默认：UTF-8
DATA：随调用发送的数据数组。例如，$args['DATA'] = array('product' => $product); 对于 /admin/products.json 产品创建 POST。
- 默认：空的array()
RETURNARRAY：将此设置为TRUE以返回array()格式的数据。 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

}

garmanio / laravel-shopify

维护者

详细信息

README

私有应用程序