Перейти к содержанию

Авторизация

Отправка звонка-сброса с паролем

Метод: POST
URL: https://beta.api.gigma.ru/counterparty/send_password
Авторизация: Не требуется
Headers: Token: {токен приложения из Gigma}

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

  • phone - номер телефона контрагента

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

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

{
    "phone": "79999999990"
}

Ответ

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

{
    "message": "Password successfully send"
}

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

  • message - информационное сообщение об успешном выполнении операции

Авторизация

Метод: POST
URL: https://beta.api.gigma.ru/counterparty/login
Авторизация: Не требуется
Headers: Token: {токен приложения из Gigma}

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

  • phone - номер телефона контрагента
  • password - последние 4 цифры номера телефона, с которого был совершён звонок-сброс (для теста использовать 1111)

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

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

{
    "phone": "79999999990",
    "password": "1111"
}

Ответ

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

{
    "counterparty": {
        "id": 1,
        "type": {
            "id": 2,
            "name": "Розница",
            "created_at": "2024-03-23T10:27:06.000000Z"
        },
        "manager": {
            "id": 1,
            "first_name": "Артём",
            "last_name": "Полищук",
            "middle_name": "Николаевич",
            "name": "Полищук Артём"
        },
        "avatar": null,
        "first_name": "Алексей",
        "last_name": "Петров",
        "middle_name": "Викторович",
        "birthday": "1980-04-02",
        "address": "630073, Новосибирская область, город Новосибирск, Новогодняя ул., д. 20/1, кв. 26",
        "phone_1": "79999999990",
        "phone_2": "78888888888",
        "email": "support@itecho.ru",
        "created_at": "2024-03-22T14:01:37.000000Z",
        "updated_at": "2024-03-23T10:48:33.000000Z",
        "access_token": {
            "value": "2|k8InFzsVIDB3sumslYax1hWJcZDglKptEgIWzxWo21bdb3d6"
        }
    }
}

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

  • id - первичный ключ
  • type - объект с информацией о типе контрагента
  • id - идентификатор типа
  • name - название типа
  • created_at - дата создания
  • manager - объект с информацией о менеджере
  • id - идентификатор менеджера
  • first_name - имя менеджера
  • last_name - фамилия менеджера
  • middle_name - отчество менеджера
  • name - полное имя менеджера
  • avatar - аватар пользователя
  • first_name - имя контрагента
  • last_name - фамилия контрагента
  • middle_name - отчество контрагента
  • birthday - дата рождения
  • address - адрес
  • phone_1 - основной номер телефона
  • phone_2 - дополнительный номер телефона
  • email - электронная почта
  • created_at - дата создания
  • updated_at - дата последнего обновления
  • access_token.value - Bearer token для авторизации в системе

Выход контрагента из системы

Метод: POST
URL: https://beta.api.gigma.ru/counterparty/logout
Авторизация: Bearer token
Headers: Token: {токен приложения из Gigma}

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

  • from_all_devices - признак выхода со всех устройств (boolean)

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

https://beta.api.gigma.ru/counterparty/logout

{
    "from_all_devices": true
}

Ответ

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

{
    "message": "User successfully logout from all devices"
}