Post Authentication
This REST API is used to get access token via POST method from the marketplace for authentication purpose. The Unicommerce sends valid user credentials in request body, which are validated by marketplace to generate an access token. This token is used in all subsequent API requests by the Uniware.
Tip
- The access token received in response is required in Header (apikey) in all subsequent API requests.
- As the token is unique for each seller, this seller-token mapping helps marketplace to identify responses for each sellers and maps the correct seller data to the api response. For instance, while using the Get Products API, the marketplace uses this token to map the respective seller catalog data and send the same in response.
Flow
Tip
Complete integration flow is available on Basic Overview page.
Basic Information
| NAME | DETAILS |
|---|---|
| Endpoint: | /authToken |
| Request Type: | POST |
| Scheme: | HTTPS |
Request Payload
{
“username”: “String”,
“password”: “String”
}Request Payload Details
| PARAMETERS | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|
| username | string | Username | Yes | - |
| password | string | Password | Yes | - |
Response Payload
The response is a valid token which is unique for each seller using Uniware.
{
"status": "SUCCESS",
"accessToken": "string"
}Response Payload Details
| PARAMETER | TYPE | DESCRIPTION | NOTES |
|---|---|---|---|
| status | string | Status of the API request | Allowable: SUCCESS, INVALID_CREDENTIALS |
| accessToken | string | Unique token | Eg.: as23djaexnsnJsnJSW34snapl |
Error Codes
Refer Response Codes section to know about specific errors codes.
FAQs/Notes
Q1. Who will handle the authentication and issue the access token?
Ans. The markeplace needs to share the username and password for each seller’s login in the Uniware to make request as described in Get Authentication and in response marketplace issue the access token for use by Uniware in subsequent API calls. As the token is unique for each seller, this seller-token mapping helps marketplace to identify responses for each sellers and maps the correct seller data to the api response.
Q2. Who will handle the expiry of access token?
Ans. The marketplace needs to decide the expiry of access token. Generally that should be 24 to 48 hours and for a specific seller for Uniware to make request as described to channel and in response channel will issue the new access token to use by Uniware in subsequent API calls.