These steps take you from nothing to a working, signed JSON API request. Each step is one short page.
Before you start#
You need:
- Admin access to a Miva store running 9.12.00 or later, with the 5.32 engine or later.
- The store’s API endpoint. It’s the store domain followed by
/mm5/json.mvc, for examplehttps://www.example.com/mm5/json.mvc. - The store code of the store you want to work with. Every request names it in
Store_Code.
Note
Some stores use a folder other than /mm5, such as /Merchant2/ or /store/. Check Domain Settings > Site Configuration for yours.
Step 1: Create an API token#
Every request carries an API token. The token decides which functions the request can run.
Step 2: Make your first request#
Pick the path that suits you. Both end with the same successful ProductList_Load_Query response.
-
Import the Miva Postman collection, fill in your store’s details and send a request. No code needed.
-
Send a request with
curl, then sign it with HMAC in PHP, Node.js or Python.
Step 3: Sign your requests#
Production integrations should sign every request with an HMAC-SHA256 signature. Miva uses the signature to check that the request came from someone with your signing key and that the body wasn’t changed on the way.
Make a signed request with HMAC
Next steps#
- Authentication and security: every token setting, header format and permission option
- Requests and responses: what goes in the body and what comes back
- Function reference: every function, grouped by area
- Troubleshooting: what each
access_deniedmessage means