Facebook Google Plus Youtube

Клиенты (client)

Метод “client”

Метод позволяет управлять записями Клиентов – добавлять, обновлять, удалять.

Запрос “fields”

Запрос позволяет получить список доступных полей, хранящих информацию о клиенте в формате – «Имя поля» - «Расшифровка назначения» для формирования дальнейших запросов.

В список включены поля, активированные в Панели управления / Формы, в т.ч. дополнительные поля (input1..input9). Не активные поля игнорируются при обработке.

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

http(s)://crm_url/developer/v1/client?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=fields

Ответ:

{
 "data":{
   "clid":"Уникальный идентификатор записи клиента в CRM",
   "uid":"Уникальный идентификатор записи клиента в вашей ИС",
   "type":"Тип записи - client,person,concurent,contractor,partner",
   "date_create":"Дата создания. Timestamp",
   "date_edit":"Дата последнего изменения. Timestamp",
   "title":"Название",
   "iduser":"Ответственный",
   "idcategory":"Отрасль",
   "head_clid":"Головн. орг-ия",
   "pid":"Осн. контакт",
   "address":"Адрес",
   "phone":"Телефон",
   "fax":"Факс",
   "site_url":"Сайт",
   "mail_url":"Почта",
   "territory":"Территория",
   "des":"Описание",
   "scheme":"Принятие решений",
   "tip_cmr":"Тип отношений",
   "recv":"Реквизиты",
   "clientpath":"Источник клиента"
 }
}

Возможные ответы в случае ошибок:

  • 400 – Не верный API key
  • 401 – Неизвестный пользователь
  • 402 – Неизвестный метод

Запрос “list”

Запрос позволяет получить список клиентов, доступных текущему сотруднику, в т.ч. с применением фильтров.

Параметры запроса (не обязательные):

  • offset – страница вывода, с учетом того, что установлен лимит в 200 записей на страницу (по умолчанию offset = 0)
  • order – поле, по которому будет производится сортировка списка (по умолчанию order = date_create)
  • first – направление сортировки ( new – сначала новые, old – сначала старые ). (по умолчанию first = new)

Фильтры (не обязательные):

  • user – ограничение по пользователю (указывается логин пользователя)
  • dateStart – начальная дата создания записи (формат - YYYY-MM-DD)
  • dateEnd – конечная дата создания записи (не обязательно, формат - YYYY-MM-DD)
    • только dateStart – вывод записей с датой создания больше указанной даты
    • только dateEnd – вывод записей с датой создания меньше указанной даты
  • word – слово поиска по полям title, des, phone, mail_url, site_url
  • fields – ограничение вывода информации по записям с разделением запятыми без пробелов. Например, при указании fields=title,phone в ответе будут получены только названия клиента и его телефон
  • bankinfo – вывод банковских реквизитов клиента (yes / no – по умолчанию)

Дополнительные фильтры: Новое

  • filter - массив, содержащий дополнительные фильтры:
    • relation - тип отношений в текстовом виде (например, "Постоянный клиент")
    • idcategory - отрасль в текстовом виде
    • territory - территория в текстовом виде
    • type - тип клиента в текстовом виде (client, person, partner, contractor, concurent)
    • clientpath - источник клиента в текстовом виде
    • trash - признак нахождения в корзине (yes/no)
    • input1...input10 - доп.поле

Пример формирования запроса в PHP:

$params['login'] = "vladislav@isaler.ru";
$params['apikey'] = 'aMgiCQyj8bCToNc47BZZYrRICoWSIl';
$params['action'] = 'list';
$params['filter']['type'] = 'client';
$params['filter']['territory'] = 'Москва';
$params['filter']['idcategory'] = 'Промышленность';
$params['filter']['clientpath'] = 'Выставка';
$params['filter']['trash'] = 'no';
$params['filter']['input1'] = 'Текст';

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

http(s)://crm_url/developer/v1/client?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=list&offset=0&order=date_create&first=&user=&dateStart=2015-01-01&dateEnd=&word=&fields=clid,title,phone

Ответ:

В поле “data” приходит список записей, в поле "count" - приходит общее количество записей в выборке

Возможные ответы в случае ошибок:

  • 400 – Не верный API key
  • 401 – Неизвестный пользователь
  • 402 – Неизвестный метод

Запрос “info”

Запрос позволяет получить информацию о клиенте по его идентификатору - clid.

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

  • clid – уникальный идентификатор записи клиента
  • ИЛИ uid – уникальный идентификатор записи клиента во внешней системе
  • fields – ограничение вывода информации по полям с разделением запятыми без пробелов. Например, при указании fields=title,phone в ответе будут получено только название клиента и его телефон
  • bankinfo – вывод банковских реквизитов клиента (yes / no – по умолчанию)

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

http(s)://crm_url/developer/v1/client?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=info&clid=100

Ответ:

{
 "data":{
   "clid":"1806",
   "uid":"fdsf44sdgfsdDGDF5",
   "type":"client",
   "date_create":"30-05-2015 23:05:30",
   "date_edit":"04-05-2015 22:44:28",
   "title":"Пробный клиент API plus",
   "iduser":"ivanov@isaler.ru",
   "idcategory":"--не определено--",
   "head_clid":"--не определено--",
   "pid":null,
   "address":null,
   "phone":"7(342)260-10-10,  7(342)260-10-11",
   "fax":null,
   "site_url":"salesman-api.ru",
   "mail_url":"test.api1@salesman-api.ru",
   "territory":"Пермь",
   "des":null,
   "scheme":null,
   "tip_cmr":"Потенциальный клиент",
   "clientpath":"Канал №1"
 }
}

Возможные ответы в случае ошибок:

  • 400 – Не верный API key
  • 401 – Неизвестный пользователь
  • 402 – Неизвестный метод
  • 403 – Клиент с указанным clid не найден в пределах аккаунта указанного пользователя
  • 404 – Не найдено
  • 405 – Отсутствуют параметры - clid клиента

Значения реквизитов клиента:

  • castUrName - Юридическое название
  • castInn - ИНН
  • castKpp - КПП
  • castBank - Банк
  • castBankKs - Кор.счет
  • castBankRs - Расч.счет
  • castBankBik - БИК банка
  • castOkpo - ОКПО
  • castOgrn ОГРН
  • castDirName - ФИО руководителя, в род.падеже (в лице кого) - Иванова Ивана Ивановича
  • castDirSignature - ФИО руководителя, Иванов И.И.
  • castDirStatus - Должность руководителя, в род.падеже, Директора
  • castDirStatusSig - Должность руководителя, например: Директор
  • castDirOsnovanie - Основание Руководителя, в род. падеже - Устава, Доверенности №ХХХ
  • castUrAddr - Юр.адрес

Запрос “add”

Запрос позволяет добавить нового клиента в базу CRM. При этом ответственным устанавливается сотрудник, логин которого использовался в запросе или указанный отдельно в параметре user

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

  • title – название клиента (обязательное поле)
  • uid – id записи во внешней системе (например в 1С)
  • type – тип записи: client (юр.лицо) – по умолчанию, person (физ.лицо), concurent, contractor, parnter
  • user – login пользователя в SalesMan CRM назначаемого Ответственным за клиента
  • прочие поля fields – информация для добавления
  • recv – массив реквизитов (см.выше), не обязательное поле

Примечание:

  • параметр date_create может быть указан в запросе. Если он отсутствует, то будет принят timestamp
  • при пустом поле user Ответственным будет назначен текущий пользователь (из запроса)
  • следующие параметры передаются в явном, текстовом виде:
    • idcategory – отрасль
    • tip_cmr – тип отношений
    • territory – территория
    • clientpath – источник клиента

В случае отсутствия переданных значений в справочниках будут созданы новые записи

Пример формирования запроса в PHP:

$params['login'] = "vladislav@isaler.ru";
$params['apikey'] = 'aMgiCQyj8bCToNc47BZZYrRICoWSIl';
$params['action'] = 'add';
$params['type'] = 'client';
$params['title'] = 'Пробный клиент API plus';
$params['phone'] = '+7(342)260-10-10, +7(342)260-10-11';
$params['mail_url'] = 'test.api1@yoolla-api.ru';
$params['site_url'] = 'yoolla-api.ru';
$params['territory'] = 'Пермь';
$params['clientpath'] = 'Сайт SalesManAPI.ru';
$params['tip_cmr'] = 'Потенциальный клиент';
$params['idcategory'] = 'Не определена';
$params['date_create'] = '2015-05-30 23:05:30';//в часовом поясе аккаунта
$params['recv']['castUrName'] = 'ООО "Пробный клиент API plus"';
$params['recv']['castInn'] = '590456789006';
$params['recv']['castKpp'] = '590404210';
$params['recv']['castBank'] = 'Филиал ОАО «УРАЛСИБ» в г. Уфа';
$params['recv']['castBankKs'] = '30101810600000000770';
$params['recv']['castBankRs'] = '40702810301220001991';
$params['recv']['castBankBik'] = '048073770';
$params['recv']['castOgrn'] = '1145958040260';
$urlparams = http_build_query($params);

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

http(s)://crm_url/developer/v1/client?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=add&bankinfo=yes&type=client&user=&title=%D0%9F%D1%80%D0%BE%D0%B1%D0%BD%D1%8B%D0%B9+%D0%BA%D0%BB%D0%B8%D0%B5%D0%BD%D1%82&phone=%2B7%28342%29260-10-10%2C+%2B7%28342%29260-10-11&mail_url=test.api1%40yoolla-api.ru&site_url=yoolla-api.ru&territory=%D0%9F%D0%B5%D1%80%D0%BC%D1%8C&clientpath=%D0%A1%D0%B0%D0%B9%D1%82+SalesManAPI.ru&tip_cmr=%D0%9F%D0%BE%D1%82%D0%B5%D0%BD%D1%86%D0%B8%D0%B0%D0%BB%D1%8C%D0%BD%D1%8B%D0%B9&idcategory=%D0%9D%D0%B5+%D0%BE%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B0

Ответ:

В поле “data” приходит id записи

{"result":"Успешно","data":1820}

Возможные ответы в случае ошибок:

  • 400 – Не верный API key
  • 401 – Неизвестный пользователь
  • 402 – Неизвестный метод
  • 405 – Отсутствуют параметры
  • 406 – Найден существующий клиент

Запрос “addlist”

Запрос позволяет добавить несколько новых клиентов в базу CRM. При этом ответственным устанавливается сотрудник, логин которого использовался в запросе или указанный отдельно в параметре user.

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

  • user – login пользователя в SalesMan CRM назначаемого Ответственным за клиентов

Запрос аналогичен запросу add, но параметры для каждой добавляемой записи передаются в массиве client

Пример формирования запроса в PHP:

$params['login'] = "vladislav@isaler.ru";
$params['apikey'] = 'aMgiCQyj8bCToNc47BZZYrRICoWSIl';
$params['action'] = 'addlist';
$params['client'][0]['type'] = 'client';
$params['client'][0]['title'] = 'Пробный клиент API 01';
$params['client'][0]['phone'] = '+7(342)260-20-10, +7(342)260-20-11';
$params['client'][0]['mail_url'] = 'test.api01@yoolla-api.ru';
$params['client'][0]['territory'] = 'Пермь';
$params['client'][0]['clientpath'] = 'Сайт SalesManAPI.ru';
$params['client'][0]['tip_cmr'] = 'Потенциальный клиент';
$params['client'][0]['recv']['castUrName'] = 'ООО "Пробный API 001"';
$params['client'][0]['recv']['castInn'] = '590456789006';
$params['client'][0]['recv']['castKpp'] = '590404210';
$params['client'][0]['recv']['castBank'] = ОАО «УРАЛСИБ» в г. Уфа';
$params['client'][0]['recv']['castBankKs'] = '30101810600000000770';
$params['client'][0]['recv']['castBankRs'] = '40702810301220001991';
$params['client'][0]['recv']['castBankBik'] = '048073770';
$urlparams = http_build_query($params);

Ответ:

Ответ приходит для каждой добавляемой записи отдельно и содержит id добавленной записи

Возможные ответы в случае ошибок:

  • 400 – Не верный API key
  • 401 – Неизвестный пользователь
  • 402 – Неизвестный метод
  • 405 – Отсутствуют параметры
  • 406 – Найден существующий клиент

Запрос “update”

Запрос позволяет обновить данные указанного клиента по его clid. При этом нет необходимости передавать все данные клиента – можно передать только изменившиеся данные.

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

  • clid – уникальный идентификатор клиента (обязательное поле)
  • ИЛИ uid – уникальный идентификатор клиента во внешней системе
  • прочие поля fields – информация для обновления
  • recv – массив реквизитов (см.выше), не обязательное поле

Примечание:

  • Реквизиты обрабатываются независимо от обновления основной информации в случае, если они указаны
  • Можно передавать только те реквизиты, которые надо обновить
  • Результат выносится в отдельный ответ recv

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

http(s)://crm_url/developer/v1/client?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=update&clid=1820& title=%D0%9F%D1%80%D0%BE%D0%B1%D0%BD%D1%8B%D0%B9+%D0%BA%D0%BB%D0%B8%D0%B5%D0%BD%D1%82

Ответ:

В поле “data” приходит id записи

{"result":"Успешно","data":1820,"recv":"Реквизиты обновлены"}

Если данные совпадают с имеющимися в базе запрос не будет обработан, но ошибки не вернет

{"result":"Данные корректны, но идентичны имеющимся","data":1820}

Возможные ответы в случае ошибок:

  • 400 – Не верный API key
  • 401 – Неизвестный пользователь
  • 402 – Неизвестный метод
  • 403 – Клиент с указанным clid не найден в пределах аккаунта указанного пользователя
  • 405 – Отсутствуют параметры - clid клиента

Запрос “delete”

Запрос позволяет удалить указанного клиента по его clid. Метод работает только в случае, если у клиента нет сделок (активных или закрытых).

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

  • clid – уникальный идентификатор клиента (обязательное поле)

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

http(s)://crm_url/developer/v1/client?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=delete&clid=1820

Ответ:

В поле “data” приходит id записи

{"result":"Успешно","data":1820}

Возможные ответы в случае ошибок:

  • 400 – Не верный API key
  • 401 – Неизвестный пользователь
  • 402 – Неизвестный метод
  • 403 – Клиент с указанным clid не найден в пределах аккаунта указанного пользователя
  • 405 – Отсутствуют параметры - clid клиента
  • 406 – Удаление клиента не возможно - есть сделки

Что-то не понятно? Задай вопрос: