SP Authentication

This REST API is used to get access token from the shipping provider/aggregator. Uniware in this POST request sends the valid username and password to get a token from shipping provider/aggregator. 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 shipper to identify responses for each sellers and maps the correct seller data to the api response. For instance, while using the Waybill Generation, the shipper uses this token to map the respective seller waybill data and send the same in response.

Flow

SP_Authentication_Flow

Tip

Complete integration flow is available on Basic Overview page.

Basic Information

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

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",
   "token": "string"
}

Response Payload Details

PARAMETER TYPE DESCRIPTION NOTES
status string Status of the API request Allowable: SUCCESS, INVALID_CREDENTIALS
token string Unique token Eg.: as23djaexnsnJsnJSW34snapl

Error Codes

Refer Response Codes section to know about specific errors codes.

Unicommerce Website

Copyright © 2022 Unicommerce eSolutions Pvt. Ltd.