user/login

Дава ключ, необходим за ползването на повечето услуги на системата

Заявка

1.json

{
    "jsonrpc": "2.0",
    "method": "login",
    "params": {
        "username": "johndoe",
        "password": "************",
        "language": "bulgarian"
    },
    "id": 1
}
  • params object
    Параметри на заявката
    • params.username stringrequired
      Потребителско име на акаунта
    • params.password stringrequired
      Парола на акаунта

Отговор

1.json

{
    "jsonrpc": "2.0",
    "result": {
        "return": true,
        "access": [
            {
                "permission_id": 1
            },
            {
                "permission_id": 2
            },
            "..."
        ],
        "username": "johndoe",
        "userdata": {
            "first_name": "John",
            "surname": "",
            "last_name": "Doe",
            "company_name": "TestCompany"
        },
        "comp_id": 1,
        "comp_type": 1,
        "user_id": 1,
        "key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "superadmin": 1
    },
    "id": 1
}
  • result object
    Резултат от заявката
    • result.return booleandeprecated
      Дали входът е успешен.
    • result.access object[]
      Списък с правата на потребителя в системата. Всяко право има за индекс - "permission_id" и стойност - id-то на правото
    • result.user_id int
      ID-то на потребителя.
    • result.username string
      Потребителското име на потребителя.
    • result.userdata object
      Допълнителни данни за потребителя
      • result.userdata.first_name string
        Име на потребителя
      • result.userdata.surname string
        Презиме на потребителя
      • result.userdata.last_name string
        Фамилно име на потребителя
      • result.userdata.company_name string
        Името на компанията на потребителя
    • result.comp_id int
      ID-то на компанията към която принадлежи потребителя.
    • result.comp_type int
      ID-то на типът на компанията към която принадлежи потребителя.
    • result.key string
      Оторизационен ключ, необходим за достъп до услугите в системата. Формат: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    • result.superadmin int
      Дали потребителя има права на супер администратор. 0/1