Confirm authorisation to access Avasam
Confirm your authorisation to access data through the API 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 |
|
|
string |
Used for user login email id (uses base64 encrypted email) |
True |
|
Password |
string |
Used for user login password (uses base64 encrypt password) |
True |
|
Code |
string |
Always blank |
False |
|
CheckMultiLogin |
string |
Used for specifying if the multi login option is in use on this account (yes/no) |
False |
Request body
The call is structured as follows:
{
"Email":"Y2lkb2RlZDEyN0BhaWNsYmQuY29t",
"Password":"MTIzNEBxd2VBUw==",
"Code":"",
"CheckMultiLogin":"yes"
}
Response
|
Field |
Type |
Description |
Notes |
|---|---|---|---|
|
Error |
Boolean |
Display the error status yes or no |
If the request is unsuccessful, return error type in ClientID |
|
ClientID |
String |
Display the user’s unique ID |
If the request is unsuccessful, return error specifics |
|
Token |
String |
Display the unique ID |
Unique identifier to authorise connections |
|
Action |
String |
Display the user login path |
|
|
EndPoint |
String |
Display the API end point path |
|
| Is Enable Product Creation | Boolean |
Confirms if products can be added to the account |
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.