Login user
Login
Method |
login.user |
Description |
Login and receiving authentication session key |
Who has access |
Partner, Customer |
Parameters of a request
Title |
Type |
Required |
Valid value |
Description |
login |
string |
yes |
|
User login |
password |
string |
yes |
|
User password |
Parameters of a reply
Title |
Type |
Required |
Description |
access_token |
string |
yes |
Authentication session key |
expire_at |
number |
yes |
Timestamp when a given token is not valid anymore |
app_id |
number |
yes |
Customer unique ID |
Lifespan of an authentication session key after calling the method "login.user"
is 1 hour. After that you need to request an authentication session key again, i.e. call the method "login.user"
.
To make a request to API, you can use a permanent authentication key that you can access in your client area at a user's level.
JSON request structure
{
"jsonrpc":"2.0",
"id":"number",
"method":"login.user",
"params":{
"login":"string",
"password":"string"
}
}
JSON reply structure
{
"jsonrpc":"2.0",
"id":"number",
"result":{
"data":{
"access_token":"string",
"expire":"number",
"app_id":"number"
}
}
}