merchium/merchium-sdk

Merchium PHP SDK

Merchium PHP SDK

Hello and welcome to Merchium PHP SDK, a Merchium app development toolkit for PHP developers., _(*1)

Merchium PHP SDK consists of the MerchiumClient.php PHP library and an example app (see it described in the docs)., _(*2)

MerchiumClient.php

Use the MerchiumClient.php library to interact with the Merchium REST API. The library contains a single class MerchiumClient which offers methods for API interaction., _(*3)

You can find the current library version in the MerchiumClient::LIB_VERSION constant., _(*4)

The MerchiumClient Class Methods

1. __construct($app_key, $shared_secret, $shop_domain = '', $access_token = '')—class constructor., _(*5)

   • $app_key—the App key app param (see the app page in your Merchium partner panel).
   • $shared_secret—the Client secret app param (see Регистрация учетной записи партнера и создание приложения).
   • $shop_domain—unique store domain at mymerchium.com (e.g. mystore.mymerchium.com).
   • $access_token—API access token.

2. setAccessToken($shop_domain)—set the API access token value., _(*6)

   • $shop_domain—unique store domain at mymerchium.com (e.g. mystore.mymerchium.com).

3. setShopDomain($access_token)—set the store domain value., _(*7)

   • $access_token—API access token.

4. getInstallationUrl($scope, $redirect_uri = '')—get the app installation link (see Authorization. AccessToken). Normally, you don't need to call this method manually, because the Marketplace generates the link itself., _(*8)

   • $scope—permission scope list.
   • $redirect_uri—post-install redirect URI .

5. requestAccessToken($code)—send a request to get an API access token., _(*9)

   • $code—temporary code, (see Authorization. AccessToken).

6. getRequest($path, $params)—send a request to get object data., _(*10)

   • $path—path to the object, i.e. part of the URL after http://STORE_NAME.mymerchium.com/api/.
   • $params—request params.

7. createRequest($path, $params)—send a request to create an object., _(*11)

   • $path—path to the object, i.e. part of the URL after http://STORE_NAME.mymerchium.com/api/.
   • $params—request params.

8. updateRequest($path, $params)—send a request to update object data., _(*12)

   • $path—path to the object, i.e. part of the URL after http://STORE_NAME.mymerchium.com/api/.
   • $params—request params.

9. deleteRequest($path)—send a request to delete an object., _(*13)

   • $path—path to the object, i.e. part of the URL after http://STORE_NAME.mymerchium.com/api/.

10. testRequest()—send a test request, e.g. to check the connection., _(*14)

11. validateSignature($get)—validate the signature of an incoming request (see Authorization. AccessToken)., _(*15)

    • $get—request params, usually a $_GET array.

12. getLastErrorStatus()—get the last error code from the API response. See Error Codes., _(*16)

13. getLastError()—get the last error message from the API response. See Error Codes., _(*17)

Errors Returned by the API

See Error Codes., _(*18)

Errors Returned by the Library

• Curl PHP module not found—the curl PHP extension not found.
• Сurl error(CODE): ERROR—errors returned by the curl extension.
• Could not JSON-encode the request data—error during JSON encoding.
• Could not JSON-decode the response—error during deconding of the server returned JSON data.
• Empty response—empty response from the server.