1. API
  2. Supplier API

Supplier - Login

Confirm authorisation to access Avasam

Confirm your authorisation to access data with your email address and password. Returns authorisation token and ClientID.

 

Call

https://app.avasam.com/api/Signup/Login

Parameters

The header details for this call are as follows:

Field name

Type

Description

Is Required

Email

string

Used for user login email id (used base64 encrypt email)

True

Password

string

Used for user login password (used base64 encrypt password)

True

Code

string

Always blank

False

CheckMultiLogin

string

Used for multi login option yes or no

False

Request body

The call is structured as follows:

{ 
"Email":"Z2F0YXBlaDY2MUBhaWNsYmQuY29t",
"Password":"MTIzNEBxd2VBUw==",
"Code":"",
"CheckMultiLogin":"yes"
}

Response

Field

Type

Description

Description

Error

bool

Display error status (yes or no)

If the request is unsuccessful, return error type

ClientID

String

Display the unique client id

If the request is unsuccessful, return error specifics

token

String

Display the unique id token value for the user

Unique identifier

EndPoint

String

Display the API endpoint path

The name of the customer’s business

Action

String

Display the user login panel path

Authorisation string for the connection
Token String Required Verification value used for later connections to Avasam
Is Enable Product Creation Boolean Required Confirm if products can be created in this account
Action String Not required  
End Point String Required Specifies the end point address for all future API queries

 

Response body

The response from Avasam will come in the following form:

{ 
"Error":false,
"ClientID":"00000000-0000-0000-0000-000000000000",
"token":"00000000-0000-0000-0000-000000000000",
"EndPoint":"https://api.avasam.com/",
"Action":"shipper.html",
}

 

Tips

  • Store the ‘Token’ value separately for repeated use in other calls until it expires.
  • Store the ‘ClientID’ value for later calls.
  • API Access calls are not counted against your API rate limit.
  • Use the ‘End Point’ URL for any API calls following this result.