Авторизация¶

Отправка пароля на электронную почту¶

Метод: POST
URL: https://beta.api.gigma.ru/send_password
Авторизация: Не требуется

Параметры запроса¶

login - адрес электронной почты.

Пример запроса¶

https://beta.api.gigma.ru/send_password

{
    "login": "2141349@mail.ru"
}

Ответ¶

При успешном действии возвращается HTTP код 200.

{
    "message": "Password successfully send"
}

message: Password successfully send

Описание полей ответа¶

message - информационное поле.

Авторизация¶

Метод: POST
URL: https://beta.api.gigma.ru/login
Авторизация: Не требуется

Параметры запроса¶

login - адрес электронной почты;
password - пароль из сообщения, полученного на электронную почту.

Пример запроса¶

https://beta.api.gigma.ru/login

{
    "login": "2141349@mail.ru",
    "password": "1111"
}

Ответ¶

При успешном действии возвращается HTTP код 200.



href="#__codelineno-3-1">{ "user": { "access_token": { "value": "28|dCWBGIqC9algoNXr6NVVg9D2fKWBaq7BJkRFyxq009cd040b" }, "id": 1, "role": { "id": 1, "name": "owner", "description": "Собственник", "created_at": "2024-03-27T07:00:46.000000Z" }, "branch": null, "department": null, "login": "2141349@mail.ru", "system_beeline_phone": "79139121349", "system_whatsapp_phone": "79139121349", "system_email": "2141349@mail.newcrab.ru", "first_name": "Артём", "last_name": "Полищук", "middle_name": "Николаевич", "birthday": "1981-05-20", "employment_date": null, "dismissal_date": null, "avatar": null, "employment_contract": null, "is_banned": false, "is_sick": false, "creator": null, "active_time": 0, "last_activity_at": null, "permissions": [ { "id": 2, "screen": null, "name": "edit-admins", "description": "Редактирование администраторов", "created_at": "2024-03-27T07:00:46.000000Z" }, { "id": 4, "screen": null, "name": "edit-users", "description": "Редактирование пользователей", "created_at": "2024-03-27T07:00:46.000000Z" }, { "id": 5, "screen": null, "name": "edit-roles", "description": "Редактирование ролей", "created_at": "2024-03-27T07:00:46.000000Z" }, { "id": 6, "screen": null, "name": "edit-permissions", "description": "Редактирование прав доступа", "created_at": "2024-03-27T07:00:46.000000Z" }, { "id": 7, "screen": null, "name": "edit-branches", "description": "Редактирование филиалов", "created_at": "2024-03-27T07:00:46.000000Z" }, { "id": 8, "screen": null, "name": "edit-departments", "description": "Редактирование отделов", "created_at": "2024-03-27T07:00:46.000000Z" }, { "id": 10, "screen": { "id": 1, "name": "Контрагенты", "created_at": "2024-03-27T07:00:46.000000Z" }, "name": "edit-counterparties", "description": "Редактирование контрагентов", "created_at": "2024-03-27T07:00:46.000000Z" }, { "id": 12, "screen": null, "name": "edit-communications", "description": "Редактирование коммуникаций", "created_at": "2024-03-27T07:00:46.000000Z" }, { "id": 14, "screen": { "id": 2, "name": "Заказы", "created_at": "2024-03-27T07:00:46.000000Z" }, "name": "edit-orders", "description": "Редактирование заказов", "created_at": "2024-03-27T07:00:46.000000Z" }, { "id": 16, "screen": { "id": 3, "name": "Задачи", "created_at": "2024-03-27T07:00:46.000000Z" }, "name": "edit-tasks", "description": "Редактирование задач", "created_at": "2024-03-27T07:00:46.000000Z" } ], "created_at": "2024-03-27T07:00:46.000000Z", "updated_at": "2024-04-03T07:07:11.000000Z" } class="p">}
Описание полей ответа¶

access_token.value - Bearer token, используемый для любых запросов в системе;
access_token.expires_at - токен годен до...;

Описание прочих полей приведено в запросе.

Получение текущего пользователя¶
Метод: GET

URL: https://beta.api.gigma.ru/user

Авторизация: Bearer token
Параметры запроса¶
Отсутствуют.
Пример запроса¶
https://beta.api.gigma.ru/user
Ответ¶
При успешном действии возвращается HTTP код 200.
{
    "user": {
        "id": 1,
        "role": {
            "id": 1,
            "name": "owner",
            "description": "Собственник",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        "branch": null,
        "department": null,
        "login": "2141349@mail.ru",
        "system_beeline_phone": "79139121349",
        "system_whatsapp_phone": "79139121349",
        "system_email": "2141349@mail.newcrab.ru",
        "first_name": "Артём",
        "last_name": "Полищук",
        "middle_name": "Николаевич",
        "birthday": "1981-05-20",
        "employment_date": null,
        "dismissal_date": null,
        "avatar": null,
        "employment_contract": null,
        "is_banned": false,
        "is_sick": false,
        "creator": null,
        "active_time": 0,
        "last_activity_at": "2024-04-03T07:07:19.000000Z",
        "permissions": [
            {
                "id": 2,
                "screen": null,
                "name": "edit-admins",
                "description": "Редактирование администраторов",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            {
                "id": 4,
                "screen": null,
                "name": "edit-users",
                "description": "Редактирование пользователей",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            {
                "id": 5,
                "screen": null,
                "name": "edit-roles",
                "description": "Редактирование ролей",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            {
                "id": 6,
                "screen": null,
                "name": "edit-permissions",
                "description": "Редактирование прав доступа",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            {
                "id": 7,
                "screen": null,
                "name": "edit-branches",
                "description": "Редактирование филиалов",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            {
                "id": 8,
                "screen": null,
                "name": "edit-departments",
                "description": "Редактирование отделов",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            {
                "id": 10,
                "screen": {
                    "id": 1,
                    "name": "Контрагенты",
                    "created_at": "2024-03-27T07:00:46.000000Z"
                },
                "name": "edit-counterparties",
                "description": "Редактирование контрагентов",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            {
                "id": 12,
                "screen": null,
                "name": "edit-communications",
                "description": "Редактирование коммуникаций",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            {
                "id": 14,
                "screen": {
                    "id": 2,
                    "name": "Заказы",
                    "created_at": "2024-03-27T07:00:46.000000Z"
                },
                "name": "edit-orders",
                "description": "Редактирование заказов",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            {
                "id": 16,
                "screen": {
                    "id": 3,
                    "name": "Задачи",
                    "created_at": "2024-03-27T07:00:46.000000Z"
                },
                "name": "edit-tasks",
                "description": "Редактирование задач",
                "created_at": "2024-03-27T07:00:46.000000Z"
            }
        ],
        "created_at": "2024-03-27T07:00:46.000000Z",
        "updated_at": "2024-04-03T07:07:11.000000Z"
    }
}

Описание полей ответа¶

id - первичный ключ пользователя
role - объект, содержащий роль пользователя в системе. Для подробной информации о полях объекта role см. запрос
branch - объект филиала, если есть. Поля объекта branch см. запрос
department - объект отдела, если есть. Поля объекта department см. запрос
login - адрес электронной почты пользователя
system_beeline_phone - системный номер телефона Beeline
system_whatsapp_phone - системный номер WhatsApp
system_email - системный адрес электронной почты
first_name - имя пользователя
last_name - фамилия пользователя
middle_name - отчество пользователя
birthday - дата рождения пользователя
employment_date - дата приема на работу
dismissal_date - дата увольнения
avatar - ссылка на аватар пользователя
employment_contract - ссылка на трудовой договор
is_banned - статус блокировки пользователя
is_sick - статус больничного
creator - объект, содержащий информацию о создателе пользователя, если есть
active_time - активное время пользователя в системе
last_activity_at - дата и время последней активности пользователя
permissions - массив объектов, содержащих права доступа пользователя


Выход пользователя из системы¶
Метод: POST

URL: https://beta.api.gigma.ru/user/logout

Авторизация: Bearer token
Параметры запроса¶

from_all_devices - признак, указывающий на необходимость выхода сразу со всех устройств.

Пример запроса¶
https://beta.api.gigma.ru/user/logout
{
    "from_all_devices": true
}

Ответ¶
При успешном действии возвращается HTTP код 200.
{
    "message": "User successfully logout from all devices"
}

Описание полей ответа¶

message - информационное поле.