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 (uses base64 encrypted email)

True

Password

string

Used for user login password (used base64 encrypt password)

True

Code

string

Always blank

False

CheckMultiLogin

string

Used for specifying if multi login option is in use (yes/no)

False

Request body

The call is structured as follows:

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

 

Response

Field

Type

Description

Description

Error

bool

Display the error status yes or no

If the request is unsuccessful, return error type

ClientID

String

Display the user’s unique id

If the request is unsuccessful, return error specifics

token

String

Display the unique id

Unique identifier

Action

String

Display the user login panel path

The name of the customer’s business

EndPoint

String

Display the API end point 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",
"Action":"seeker.html",
"EndPoint":"https://api.avasam.com/"
}

 

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.