Skip to content

Login user

Login

Method login.user
API version v4.0
Go back to the methods list

Request parameters

Title Type Required Description
login string yes User login
password string yes User password

Reply parameters

Title Type Required Description
access_token string yes Authentication session key
expire_at number yes Timestamp when a distributed token becomes invalid

Lifespan of a distributed authentication session key after calling the login.user method is 1 hour. Upon the expiry of a session key you need to request it again, calling the login.user method.

To make a request to API you can use a permanent authentication key which is accessible in your client area (refer to Access by key).

Example of a request

{
  "jsonrpc": "2.0",
  "id": "req1",
  "method": "login.user",
  "params": {
    "login": "your_login",
    "password": "your_password"
  }
}

Example of a reply

{
  "jsonrpc": "2.0",
  "id": "req1",
  "result": {
    "data": {
      "access_token": "2fRN4g217ca0b4224a67988aff3e584f91964a692045415f36fa66146f5a3c1ae1f6093d",
      "expire_at": 1475853742
    }
  }
}