README

大家好，欢迎来到 Merchium PHP SDK，这是一个为 PHP 开发者提供的 Merchium 应用开发工具包。

Merchium PHP SDK 包括 MerchiumClient.php PHP 库和一个示例应用（在 文档 中有描述）。

MerchiumClient.php

使用 MerchiumClient.php 库与 Merchium REST API 进行交互。该库包含一个 MerchiumClient 类，它提供了与 API 交互的方法。

您可以在 MerchiumClient::LIB_VERSION 常量中找到当前库版本。

MerchiumClient 类方法

1. __construct($app_key, $shared_secret, $shop_domain = '', $access_token = '')—类构造函数。

• $app_key—应用密钥参数（在 Merchium 合作伙伴控制面板中的应用页面中查看）。
• $shared_secret—客户端密钥参数（见 注册合作伙伴帐户和创建应用程序）。
• $shop_domain—mymerchium.com 上的唯一商店域名（例如 mystore.mymerchium.com）。
• $access_token—API 访问令牌。

1. setAccessToken($shop_domain)—设置 API 访问令牌值。

• $shop_domain—mymerchium.com 上的唯一商店域名（例如 mystore.mymerchium.com）。

1. setShopDomain($access_token)—设置商店域名值。

• $access_token—API 访问令牌。

1. getInstallationUrl($scope, $redirect_uri = '')—获取应用安装链接（见 授权. 访问令牌）。通常，您不需要手动调用此方法，因为 Marketplace 会自动生成链接。

• $scope—权限范围列表。
• $redirect_uri—安装后重定向 URI。

1. requestAccessToken($code)—发送请求以获取 API 访问令牌。

• $code—临时代码，(见 授权. 访问令牌).

1. getRequest($path, $params)—发送请求以获取对象数据。

• $path—对象路径，即 URL 中 http://STORE_NAME.mymerchium.com/api/ 后的部分。
• $params—请求参数。

1. createRequest($path, $params)—发送请求以创建对象。

• $path—对象路径，即 URL 中 http://STORE_NAME.mymerchium.com/api/ 后的部分。
• $params—请求参数。

1. updateRequest($path, $params)—发送请求以更新对象数据。

• $path—对象路径，即 URL 中 http://STORE_NAME.mymerchium.com/api/ 后的部分。
• $params—请求参数。

1. deleteRequest($path)—发送请求以删除对象。

• $path—对象路径，即 URL 中 http://STORE_NAME.mymerchium.com/api/ 后的部分。

1. testRequest()—发送测试请求，例如检查连接。

2. validateSignature($get)—验证传入请求的签名（见 授权. 访问令牌）。

• $get—请求参数，通常是 $_GET 数组。

1. getLastErrorStatus()—从 API 响应中获取最后一个错误代码。见 错误代码。

2. getLastError()—从 API 响应中获取最后一个错误消息。见 错误代码。

API 返回的错误

见 错误代码。

库返回的错误

• Curl PHP模块未找到—未找到curl PHP扩展。
• Curl错误（CODE）：ERROR—curl扩展返回的错误。
• 无法JSON编码请求数据—JSON编码过程中出错。
• 无法解码响应—解码服务器返回的JSON数据时出错。
• 空响应—服务器返回的响应为空。