Get Authentication

This REST API is used to get access token via Get method from the marketplace for authentication purpose. The Unicommerce sends valid user credentials in request body, which are validated by marketplace to issue an access token.

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 marketplaces 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

Authentication_Flow

Tip

Complete integration flow is available on Basic Overview page.

Basic Information

NAME DETAILS
Usage: Mandatory
Endpoint: /authToken
Request Type: GET
Scheme: HTTPS
Header (Content-Type): application/json

Sample URL

https://{marketplace}.com/authToken?username=abc&password=123

Query Parameters

PARAMETERS TYPE DESCRIPTION MANDATORY NOTES
username string Username Yes -
password string Password Yes -

Response Payload

The response is a valid auth. token which is unique for each seller.

{
   "status": "SUCCESS",
   "accessToken": "string"
}

Response Payload Details

PARAMETERS TYPE DESCRIPTION MANDATORY NOTES
status string Status of the request Yes Allowable: SUCCESS
accessToken string Authorization Token Yes 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.

Unicommerce Website

Copyright © 2022 Unicommerce eSolutions Pvt. Ltd.