Miva
To set up the Miva connector, you need to authenticate with the following details.
Get store domain
You can find the domain of your store in your store URL. For example, if your store URL is https://mydomain.mivamerchantdev.com/
then the store domain is mydomain.mivamerchantdev.com
.
Get store folder
You can find your store folder in the admin URL of your store. For example, if the admin URL of your store is https://mydomain.mivamerchantdev.com/mm5/admin.mvc
then the store folder is mm5
. For more information, see Miva's documentation on API Endpoints.
Get store code
You can find your store code in your store URL. For example, if your store URL is https://mydomain.mivamerchantdev.com/
then the store code is mydomain
.
Generate signature
You can generate a signature from the Miva admin page of your store under Users > API tokens. For mroe information, see Miva's documentation on Authentication.
Generate access token
You can generate an access token from the Miva admin page of your store under Users > API tokens. For more information, see Miva's documentation on Authentication.
Cyclr setup
Cyclr asks you for the below values when you install the Miva connector into an account:
Value | Description |
---|---|
Domain | The domain of the store to access. |
Folder | The folder of the store to access. |
Store Code | The store code of the store to access. |
Signature | The HMAC-SHA256 signature to use for authentication. |
Access Token | The access token to use for authentication. |
Note: You can use different details for different accounts.
Additional information
Generate a HMAC for step script
All Miva API requests require you to send a HMAC signature with every request. The connector automatically generates a HMAC signature before every request and uses the request body as part of the encoding when when it generates the signature.
If you use step script with a before_action
function to modify the body of a request, the function causes a mismatch between the generated HMAC signature and the request body. To avoid the problem, you need to manually regenerate the HMAC signature. In this case, you need to add a RegenerateHmacSignature()
call before the final return true
. For example:
function before_action() {
if (method_request != null && method_request.fields == null) {
method_request.fields = ['id', 'first_name', 'last_name'];
}
RegenerateHmacSignature(); /* Regenerate HMAC signature. */
return true;
}