-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtutorials-data.json
More file actions
14 lines (14 loc) · 4.46 KB
/
tutorials-data.json
File metadata and controls
14 lines (14 loc) · 4.46 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
{
"id": "1760630070580",
"title": "How do I authenticate API requests?",
"content": "Obtain UUID and Private Key (MMS 1.0 version) :\n\n Navigate to E-Commerce → Merchant → Merchant Store Status in the MMS system.\n\n 1. Click \"Search\", and the system will list your store list.\n 2. Select the store.\n 3. Click “Edit” to enter the store detail page.\n\n Scroll down the page, find \"Enable Open API\". \n Enable Open API by selecting \"Yes\" under the \"Enable Open API\" option. The system will generate a UUID and Private Key for the store.\n\n Copy theUUIDandPrivate Key, then scroll down to click \"Save\" button to save the settings.\n UUIDand \n Private Keyare displayed only once. If you leave the page without copying, you will need to disable and re-enable the Open API to regenerate them.\n\n Obtain UUID and Private Key (MMS 2.0 version) :\n\n Navigate to Store Management → Store Basic Settings in the MMS2.0 system.\n\n 1. Find your stroe.\n 2. Click “Edit” to enter the edit store page.\n\n Copy theUUIDandPrivate Key, then scroll down to click \"Save\" button to save the settings.\n Important : The\n UUIDand \n Private Keyare displayed only once. If you leave the page without copying, you will need to disable and re-enable the Open API to regenerate them.\n\n Generate x-auth-token:\n\n Method 1 - Visit the JWT Token Generator page.\n\n Click\n\n Refresh\n to get the latest timestamp.\n ( The iat value must be updated every 30 minutes for the token to remain valid. )\n\n Paste the UUID you just copied into the “X-API-Key (UUID)” field.\n Paste the private key you just copied into the “RSA Private Key (PEM format)” field. \n\n Method 2 - Generate Token Without Using the Online Generator\n\n JWT Token Generatoronline tool is mainly for non-engineers to generate tokens for temporary testing purposes.\n IT(developer)can directly create the JWT through code and include the following Header::\n {\n \"alg\": \"RS256\",\n \"typ\": \"JWT\"\n}\n Example of the Payload, ( iat needs to be refreshed every 30 minutes):\n {\n \"sub\": \"shoalter\",\n \"name\": \"shoalter\",\n \"iat\": {{current_unix_timestamp }},\n \"x-api-key\": \"{{your_UUID_from_MMS_system}}\"\n}\n\nThen use your Private Key together with the above Header and Payload information to generate the token using the RS256 algorithm.\n\n Use x-auth-token in API requests:Include the generated JWT token as the value of the \n \"x-auth-token\" field in the request headers.\n\n Error Handling:If the token is invalid or expired, the API will return an \n HTTP 401 Unauthorized status code. Please verify your token and ensure the timestamp is up-to-date.Note for MMS System:UUID and Private Key must be saved before they become active. Once saved, the UUID/Key will be hidden. Reopening the API will generate a new set of credentials.",
"category": "Authentication"
},
{
"id": "1762308577585",
"title": "How to Contact Technical Support",
"content": "If merchants encounter difficulties or have questions while using the Open API features, they can contact the technical support team via:Email Address: production.issues.mms@shoalter.comEmail Subject FormatPlease set the email subject as:{Your Store ID} - Open API inquires - {The Issue You Encountered}Required InformationIn the email, please provide the following details to help the support team quickly identify the issue:API Endpoint: Specify the API URL where the issue occurred.Error Information or Problem Description: Attach relevant videos or screenshots to describe the issue.Problem Overview: Briefly summarize the issue encountered.Trigger Time: The specific time when the issue occurred.Request Body: Provide the Body information of the API request.Request Result: Share the API response details.ExampleHere is an example of using the GET Stock API:API URL: https://merchant-oapi.shoalter.com/oapi/api/inventory/stock/detailsRequest Body:[\n {\n \"warehouseId\": \"\",\n \"productId\": \"H8888881_S_072705116546\"\n }\n]\nRequest Result:{\n \"message\": \"authentication fail\",\n \"code\": \"error\",\n \"data\": null\n}",
"category": "General"
}
]