Справочники (guides)
Метод “guides”
Метод позволяет получить информацию по записям из справочников системы.
Пример запроса:
http(s)://crm_url/developer/v1/guides?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=users
Возможные ответы в случае ошибок:
- 400 – Не верный API key
- 401 – Неизвестный пользователь
- 402 – Неизвестный метод
Запрос “user”
Запрос позволяет получить расширенню информацию о Пользователе аккаунта
Параметры запроса:
- login – Логин пользователя
- uid – уникальный идентификатор, связанный с внешней ИС или
- iduser - уникальный идентификатор в CRM
Можно указать либо uid (он должен быть добавлен в систему), либо iduser требуемого пользователя. Первоначально проверяется uid.
Ответ:
Полученный ответ содержит данные:
- iduser - уникальный идентификатор в CRM
- uid – уникальный идентификатор, связанный с внешней ИС
- oid – уникальный идентификатор отдела, связанный с внешней ИС
- title - имя Пользователя
- login – логин Пользователя
- active – Статус пользователя (yes – активен, no – заблокирован)
- tip - роль в системе
- user_post - должность
- email - email пользователя (для пользователей нашего сервиса совпадает с логином)
- phone - телефон
- phone_in - внутренний телефон (для sip-аккаунтов)
- mob - мобильный телефон
Запрос “users”
Запрос позволяет получить список Пользователей аккаунта
Ответ:
Полученный ответ содержит данные:
- iduser - уникальный идентификатор в CRM
- uid – уникальный идентификатор, связанный с внешней ИС
- oid – уникальный идентификатор отдела, связанный с внешней ИС
- title – Имя пользователя
- login – Логин пользователя
- email – Email пользователя
- active – Статус пользователя (yes – активен, no – заблокирован)
Запрос “useradd”
Запрос позволяет добавить нового Пользователя
Параметры запроса:
- uid – уникальный идентификатор, связанный с внешней ИС
- login – Логин пользователя (для SalesMan Online это email)
- password - Пароль пользователя
- title – Имя пользователя
- mid - Идентификатор (uid) руководителя Пользователя в вашей системе (должен совпадать с идентификатором в CRM)
- otdel - Идентификатор (oid) отдела во внешней системе
- tip - роль в системе
- user_post - должность
- email - email пользователя (для пользователей нашего сервиса совпадает с логином)
- phone - телефон
- phone_in - внутренний телефон (для sip-аккаунтов)
- mob - мобильный телефон
Ответ:
В случае успешного запроса вернется iduser в поле data
Возможные ответы в случае ошибок:
- 400 – Не верный API key
- 401 – Неизвестный пользователь
- 402 – Неизвестный метод
- 406 - Такой логин уже существует
- 500 - Внутренняя ошибка
Запрос “category”
Запрос позволяет получить информацию из справочника Отрасли.
Ответ:
Полученный ответ содержит данные:
- title – Название отрасли
- tip – Тип записи, к которой относится отрасль
- client – Клиент юр.лицо
- person – Клиент физ.лицо
- partner – Партнер
- contractor – Поставщик
- concurent – Конкурент
Запрос “territory”
Запрос позволяет получить информацию из справочника Территории.
Ответ:
Полученный ответ содержит данные:
- title – Название территории
Запрос “relations”
Запрос позволяет получить информацию из справочника Тип отношений (параметр tip_cmr).
Пример запроса:
http(s)://crm_url/developer/v1/guides?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=relations
Ответ:
Полученный ответ содержит данные:
- title – Название типа отношений
- color – Цветовая схема
Запрос “clientpath”
Запрос позволяет получить информацию из справочника Источник клиента (параметр clientpath).
Пример запроса:
http(s)://crm_url/developer/v1/guides?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=clientpath
Ответ:
Полученный ответ содержит данные:
- id – id записи в базе данных
- title – Название источника
- utm_source - UTM-метка для сопоставления с каналом
- destination - номер входящей линии для сопоставления с каналом
Запрос “mycompany”
Запрос позволяет получить информацию из справочника Мои компании (параметр mcid в сделках).
Пример запроса:
http(s)://crm_url/developer/v1/guides?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=mycompany
Ответ:
Полученный ответ содержит данные:
- mcid – ID компании
- title – Короткое название компании
Запрос “mybank”
Запрос позволяет получить информацию из справочника Мои компании/Банковские счета (параметр rs в выставлении счетов).
Пример запроса:
http(s)://crm_url/developer/v1/guides?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=mybank
Ответ:
Полученный ответ содержит данные:
- id – ID расчетного счета (используется при выставлении счетов)
- mcid – ID компании
- title – Название расчетного счета