IntraVision

Все возможности системы
< Список статей

IntraDesk API. Получить Пользователя клиента, Клиента, Сотрудника

В данной статье подготовлена инструкция по получению ID пользователя клиента, клиента, сотрудника через API. Получение ID необходимо для того, чтобы иметь возможность создать заявку от конкретного пользователя клиента, клиента, сотрудника. Инструкция по созданию заявок через API описана в Статье №27191. 

Для многих API запросов требуется указать ID (идентификатор) пользователя, клиента. Под пользователем, в данном случае, понимается Пользователь клиента или Сотрудник, под клиентом - Клиент Физ.лицо или Клиент Юр лицо.

Например, идентификатор нужен, чтобы создать по API заявку от лица определенного пользователя клиента, назначить Пользователя исполнителем или Наблюдателем на заявку, отобрать все заявки где какой-то пользователь является Заявителем.

Мы рекомендуем искать пользователя клиента / клиента / сотрудника  через соответствующие разделы "Пользователи клиента" (ClientUsers), "Клиенты" (Clients), "Сотрудники" (Employees), фильтруя поиск по email, ФИО, телефону и тд. 

Разделы инструкции:

Поиск ID пользователя клиента / клиента / сотрудника по email. 
   Пример запроса поиска по Email ID Пользователя через ClientUsers.
   Пример запроса поиска по Email ID клиента через Clients.
   Пример запроса поиска по Email ID сотрудника через Employees.
Фильтрация по пользователю клиента /клиенту / сотруднику по другим параметрам.
   Пример фильтрации по ФИО.
   Пример фильтрации по телефону.

Поиск ID пользователя клиента / клиента / сотрудника по email.

Email является уникальным идентификатором пользователя клиента / сотрудника / клиента. Ниже приведем примеры поиска пользователя клиента / сотрудника / клиента с фильтрацией по email. 

Пример запроса поиска по Email (ivan.petrov@intradesk.ru) ID Пользователя через ClientUsers.

Если у нас стоит цель создать заявку от пользователя клиента, то мы должны знать id пользователя и id клиента, к которому он прикреплен. 

Запрос:

GET https://apigw.intradesk.ru/settings/odata/ClientUsers?ApiKey=D5FFE9F0F190416BA808B8C312&$filter=(Email eq 'ivan.petrov@intradesk.ru') 

Расшифровка значений запроса:

  • «Apikey» - идентификатор для авторизации. Значение Apikey можно получить в Intradesk в разделе: Настройки -> Интеграции -> Apikey
  • «ClientUsers» - используется для поиска по разделу "Пользователи клиента"
  • «$filter»  - используется для фильтрации списка пользователей клиентов. 
  • «$filter=(Email eq 'ivan.petrov@intradesk.ru')» - используется для фильтрации по email
В ответе мы получаем:

  • Значение поля "id": 286625  - является искомым id пользователя.
  • Значение поля "userGroupId": "19443" в "groups"- является id клиента. 
  • Параметр  "isDefault": true" в  "groups" - означает, что данный клиент является основным у пользователя.  
  • Параметр "isDefault": false" в "groups" - означает, что данный клиент не основной у пользователя.
 
 

Пример запроса поиска по Email (intradesk@mycompany.ru) ID клиента через Clients.

Запрос:

Расшифровка значений запроса:
  • «Apikey» - идентификатор для авторизации. Значение Apikey можно получить в Intradesk в разделе: Настройки -> Интеграции -> Apikey
  • «Clients» - используется для поиска по разделу "Клиенты"
  • «$filter» - используется для фильтрации списка клиентов.
  • «$filter=(Email eq 'intradesk@mycompany.ru')» - используется для фильтрации по email
В ответе мы получаем:
  • Значение поля "id": 154126 - является искомым id клиента.
 
 

Пример запроса поиска по Email (maximsemenov@intradesk.ru) ID сотрудника через Employees.

Расшифровка значений запроса:
  • «Apikey» - идентификатор для авторизации. Значение Apikey можно получить в Intradesk в разделе: Настройки -> Интеграции -> Apikey
  • «Employees» - используется для поиска по разделу "Сотрудники"
  • «$filter» - используется для фильтрации списка сотрудников.
  • «$filter=(Email eq 'maximsemenov@intradesk.ru')» - используется для фильтрации по email
В ответе мы получаем:
  • Значение поля "id": 286639 - является искомым id сотрудника.
 
 

Фильтрация по пользователю клиента /клиенту / сотруднику по другим параметрам.

Помимо фильтра по email, есть возможность фильтровать и по другим параметрам. 

Пример фильтрации по ФИО.

Разберем на примере фильтрации по ФИО (Дмитриев Иван Семенович) пользователя клиента через раздел ClientUsers. 
Запрос:
GET https://apigw.intradesk.ru/settings/odata/ClientUsers?ApiKey=D5FFE9F0F190416BA808B8C312&$filter=(name eq 'Дмитриев Иван Семенович') 

Расшифровка значений запроса:
  • «Apikey» - идентификатор для авторизации. Значение Apikey можно получить в Intradesk в разделе: Настройки -> Интеграции -> Apikey
  • «ClientUsers» - используется для поиска по разделу "Пользователи клиента"
  • «$filter» - используется для фильтрации списка пользователей клиентов.
  • «$filter=(name eq 'Дмитриев Иван Семенович')» - используется для фильтрации по ФИО
В ответе мы получаем:
  • Значение поля "id": 116160 - является искомым id пользователя.
  • Значение поля "userGroupId": "12597" в "groups"- является id клиента.
  • Параметр "isDefault": true" в "groups" - означает, что данный клиент является основным у пользователя.
  • Параметр "isDefault": false" в "groups" - означает, что данный клиент не основной у пользователя.
 
 

Пример фильтрации по телефону.

Разберем на примере фильтрации по телефону (+7 909 900-12-34) пользователя клиента через раздел ClientUsers.
Запрос:
GET https://apigw.intradesk.ru/settings/odata/ClientUsers?&$filter=(contains(phoneNumbersSearch, '+7 909 900-12-34'))&ApiKey=D5FFE9F0F190416BA808B8C312 

Расшифровка значений запроса:
  • «Apikey» - идентификатор для авторизации. Значение Apikey можно получить в Intradesk в разделе: Настройки -> Интеграции -> Apikey
  • «ClientUsers» - используется для поиска по разделу "Пользователи клиента"
  • «$filter» - используется для фильтрации списка пользователей клиентов.
  • «$filter=(contains(phoneNumbersSearch, '+7 909 900-12-34'))» - используется для фильтрации по номеру телефона.  Позволяет ввести телефон с символами +()- и пробелами. В выдаче может быть больше 1-го пользователя - чем больше цифр номера, тем меньше выдача.
В ответе мы получаем:
  • Значение поля "id": 187218 - является искомым id пользователя.
  • Значение поля "userGroupId": "19443" в "groups"- является id клиента.
  • Параметр "isDefault": true" в "groups" - означает, что данный клиент является основным у пользователя.
  • Параметр "isDefault": false" в "groups" - означает, что данный клиент не основной у пользователя.
 
 

API