Welcome to the API documentation! This guide will help you get started with using our API for retrieving product information. Follow the steps below to authenticate and make your first API call.Prerequisites#
Before you begin, ensure you have the following information from your contact person:Test Domain: The domain used for testing purposes.
Production Domain: The domain used for live data.
Access Credentials: Your company id, site id, username and password.
Step 1: Authentication#
To interact with our API, you first need to authenticate and obtain an access token. You can do this by making a login call. Below are the details for the login endpoint.Login Endpoint#
For more details on login endpoint and their functionalities, please refer to the complete API documentation here.Example Request#
Replace YOUR_DOMAIN, COMPANY_ID, SITE_ID, USERNAME and PASSWORD with your data.Response#
A successful login will return a JSON response containing the access token.{
"username": "[USERNAME]",,
"companyId": "[COMPANY_ID]",
"siteId": [SITE_ID],
"token": "[YOUR_TOKEN]",
"expires": "2024-06-07T07:27:21.420Z",
"expiresInMS": 285000
}
Step 2: Using the Access Token#
Once you have the access token, you can use it to authenticate subsequent API calls. Below is an example of how to use the token to retrieve product information.Products Info Endpoint#
For more details on products endpoint and their functionalities, please refer to the complete API documentation here.Example Request#
Replace YOUR_DOMAIN and YOUR_TOKEN with your data.Response#
A successful request will return a status code 200 response with JSON body response.Summary#
1.
Obtain the test and production domains, and your access credentials from your contact person.
2.
Authenticate using the login endpoint to receive an access token.
3.
Use the access token to make authenticated API calls to retrieve product information.
Modified at 2024-06-07 07:29:20
