Контакты (person)
Метод “person”
Метод позволяет управлять записями Контактов – добавлять, обновлять, удалять. Метод аналогичен методу “client”, но в нем отсутствуют специфичные сущности Клиент параметры.
Запрос “fields”
Запрос позволяет получить список доступных полей, хранящих информацию о клиенте в формате – «Имя поля» - «Расшифровка назначения» для формирования дальнейших запросов.
В список включены поля, активированные в Панели управления / Формы. Не активные поля игнорируются при обработке.
Пример запроса:
http(s)://crm_url
/developer/v1/person?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=fields
Ответ:
{
"data":{
"pid":"Уникальный идентификатор записи контакта",
"date_create":"Дата создания. Timestamp",
"date_edit":"Дата последнего изменения. Timestamp",
"clid":"Клиент",
"ptitle":"Должность",
"person":"Ф.И.О.",
"tel":"Тел.",
"fax":"Факс",
"mob":"Моб.",
"mail":"Почта",
"rol":"Роль",
"social":"Прочее",
"iduser":"Ответственный",
"loyalty":"Лояльность",
"input1":"Дата рождения",
"clientpath":"Источник клиента",
"blog":"Блог",
"mysite":"Сайт",
"twitter":"Twitter",
"icq":"ICQ",
"skype":"Skype",
"google":"Google",
"yandex":"Я.ru",
"mykrug":"Мой круг"
}
}
Возможные ответы в случае ошибок:
- 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 – слово поиска по полям person, ptitle, tel, mail
- fields – ограничение вывода информации по записям с разделением запятыми без пробелов. Например, при указании fields= person,tel в ответе будут получены только ФИО контакта и его телефон
- socinfo – включает вывод социальных контактов (Блог, Сайт, Twitter, ICQ, Skype, Google, Я.ru, Мой круг)
Дополнительные фильтры: Новое
- filter - массив, содержащий дополнительные фильтры:
- clid - идентификатор клиента (целое число)
- clientpath - источник клиента в текстовом виде
- input1...input10 - доп.поле
Пример формирования запроса в PHP:
$params['login'] = "vladislav@isaler.ru";
$params['apikey'] = 'aMgiCQyj8bCToNc47BZZYrRICoWSIl';
$params['action'] = 'list';
$params['filter']['clid'] = '100';
$params['filter']['clientpath'] = 'Выставка';
$params['filter']['input1'] = 'Текст';
Пример запроса:
http(s)://crm_url
/developer/v1/person?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=list&offset=0&order=date_create&first=&user=&dateStart=2015-01-01&dateEnd=&word=&fields=pid,person,tel
Ответ:
В поле “data” приходит список записей, в поле "count" - приходит общее количество записей в выборке
Возможные ответы в случае ошибок:
- 400 – Не верный API key
- 401 – Неизвестный пользователь
- 402 – Неизвестный метод
Запрос “info”
Запрос позволяет получить информацию о клиенте по его идентификатору - pid.
Параметры запроса:
- pid – уникальный идентификатор записи клиента
- fields – ограничение вывода информации по полям с разделением запятыми без пробелов. Например, при указании fields=title,phone в ответе будут получено только название клиента и его телефон
- socinfo – включает вывод социальных контактов (Блог, Сайт, Twitter, ICQ, Skype, Google, Я.ru, Мой круг)
Пример запроса:
http(s)://crm_url
/developer/v1/person?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=info&pid=2475
Ответ:
{ "data":{
"pid":"2475",
"date_create":"2010-12-01 00:00:00",
"date_edit":"2015-04-08 15:53:55",
"clid":"1200",
"client":"Юлла, ООО",
"ptitle":"Коммерческий директор",
"person":"Андреев Владислав Германович",
"tel":"+7(342)2545577, +7(342)2067202",
"fax":"",
"mob":"+79223289466, +79128844139",
"mail":"a.vladislav@isaler.ru",
"rol":"Участвует в принятии решения; Принимает решение;",
"iduser":"vladislav@isaler.ru",
"loyalty":null,
"clientpath":"Рекомендации клиентов"
}
}
Возможные ответы в случае ошибок:
- 400 – Не верный API key
- 401 – Неизвестный пользователь
- 402 – Неизвестный метод
- 403 – Клиент с указанным pid не найден в пределах аккаунта указанного пользователя
- 404 – Не найдено
- 405 – Отсутствуют параметры - pid контакта
Запрос “add”
Запрос позволяет добавить нового контакта в базу CRM. При этом ответственным устанавливается сотрудник, логин которого использовался в запросе или указанный отдельно в параметре user
Параметры запроса:
- person – название клиента (обязательное поле)
- user – login пользователя в SalesMan CRM назначаемого Ответственным за клиента
- прочие поля fields – информация для добавления
- socials – поля для социальных контактов
- blog => Блог
- mysite => Сайт
- twitter => Twitter
- icq => ICQ
- skype => Skype
- google => Google
- yandex => Я.ru
- mykrug => Мой круг
Примечание:
- параметр date_create может быть указан в запросе. Если он отсутствует, то будет принят timestamp
- при пустом поле user Ответственным будет назначен текущий пользователь (из запроса)
- следующие параметры передаются в явном, текстовом виде:
- loyalty – лояльность
- clientpath – источник клиента
В случае отсутствия переданных значений в справочниках будут созданы новые записи
Пример формирования запроса в PHP:
$params['login'] = "vladislav@isaler.ru";
$params['apikey'] = 'aMgiCQyj8bCToNc47BZZYrRICoWSIl';
$params['action'] = 'add';
$params['person'] = 'Апиров Апист';
$params['ptitle'] = 'Типа дирехтор';
$params['tel'] = '+7(342)280-10-10, +7(342)280-10-11';
$params['mail'] = 'test.api100@yoolla-api.ru';
$params['clientpath'] = 'Сайт SalesManAPI.ru';
$params['loyalty'] = 'Пока не понятно';
$params['socials']['blog'] = 'http://api.blog.rus';
$params['socials']['mysite'] = 'http://apipai.rus';
$params['socials']['twitter'] = 'apipai';
$params['socials']['icq'] = '123456789';
$params['socials']['skype'] = 'apipai';
$urlparams = http_build_query($params);
Пример запроса:
http(s)://crm_url
/developer/v1/person?login=vladislav%40isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=add&user=&person=%D0%90%D0%BF%D0%B8%D1%80%D0%BE%D0%B2+%D0%90%D0%BF%D0%B8%D1%81%D1%82&ptitle=%D0%A2%D0%B8%D0%BF%D0%B0+%D0%B4%D0%B8%D1%80%D0%B5%D1%85%D1%82%D0%BE%D1%80&tel=%2B7%28342%29280-10-10%2C+%2B7%28342%29280-10-11&mob=%2B7%28922%29200-20-20&mail=test.api100%40yoolla-api.ru
Ответ:
{"result":"Успешно","data":2502}
Возможные ответы в случае ошибок:
- 400 – Не верный API key
- 401 – Неизвестный пользователь
- 402 – Неизвестный метод
- 405 – Отсутствуют параметры
- 406 – Найден существующий контакт
Запрос “addlist”
Запрос позволяет добавить несколько новых клиентов в базу CRM. При этом ответственным устанавливается сотрудник, логин которого использовался в запросе или указанный отдельно в параметре user.
Параметры запроса:
- user – login пользователя в SalesMan CRM назначаемого Ответственным за клиентов
Запрос аналогичен запросу add, но параметры для каждой добавляемой записи передаются в массиве persons
Пример формирования запроса в PHP:
$params['login'] = "vladislav@isaler.ru";
$params['apikey'] = 'aMgiCQyj8bCToNc47BZZYrRICoWSIl';
$params['action'] = 'addlist';
$params['persons'][0]['person'] = 'Апиров Апист';
$params['persons'][0]['ptitle'] = 'Типа дирехтор';
$params['persons'][0]['tel'] = '+7(342)280-10-10, +7(342)280-10-11';
$params['persons'][0]['mob'] = '+7(922)200-20-20';
$params['persons'][0]['mail'] = 'test.api100@yoolla-api.ru';
$params['persons'][0]['clientpath'] = 'Сайт SalesManAPI.ru';
$params['persons'][0]['loyalty'] = 'Пока не понятно';
$params['persons'][0]['socials']['blog'] = 'http://api.blog.rus';
$params['persons'][0]['socials']['mysite'] = 'http://apipai.rus';
$params['persons'][0]['socials']['twitter'] = 'apipai';
$params['persons'][0]['socials']['icq'] = '123456789';
$params['persons'][0]['socials']['skype'] = 'apipai';
$params['persons'][0]['socials']['google'] = 'apipai';
$params['persons'][0]['socials']['yandex'] = 'apipai';
$params['persons'][0]['socials']['mykrug'] = 'apipai';
$urlparams = http_build_query($params);
Ответ:
Ответ приходит для каждой добавляемой записи отдельно
[{"result":"Успешно","data":2509}]
Если данные совпадают с имеющимися в базе запрос не будет обработан, но ошибки не вернет:
[{"result":"Error","error":{"code":"406","text":"Найден существующий контакт - Апиров Апист (pid = 2509). Запрос отклонен."}}]
Возможные ответы в случае ошибок:
- 400 – Не верный API key
- 401 – Неизвестный пользователь
- 402 – Неизвестный метод
- 405 – Отсутствуют параметры
- 406 – Найден существующий контакт
Запрос “update”
Запрос позволяет обновить данные указанного клиента по его clid. При этом нет необходимости передавать все данные клиента – можно передать только изменившиеся данные.
Параметры запроса:
- pid – уникальный идентификатор контакта (обязательное поле)
- прочие поля fields – информация для обновления
- socials – информация для обновления
Пример запроса:
http(s)://crm_url
/developer/v1/person?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=update&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
Ответ:
{"result":"Успешно","data":"2509","social":"Соц.контакты обновлены"}
Если данные совпадают с имеющимися в базе запрос не будет обработан, но ошибки не вернет:
{"result":"Данные корректны, но идентичны имеющимся","data":2509}
Возможные ответы в случае ошибок:
- 400 – Не верный API key
- 401 – Неизвестный пользователь
- 402 – Неизвестный метод
- 403 – Клиент с указанным pid не найден в пределах аккаунта указанного пользователя
- 405 – Отсутствуют параметры - pid контакта
Запрос “delete”
Запрос позволяет удалить указанного клиента по его clid. Метод работает только в случае, если у клиента нет сделок (активных или закрытых).
Параметры запроса:
- pid – уникальный идентификатор контакта (обязательное поле)
Пример запроса:
http(s)://crm_url
/developer/v1/person?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=delete&pid=2509
Ответ:
{"result":"Успешно","data":2509}
Возможные ответы в случае ошибок:
- 400 – Не верный API key
- 401 – Неизвестный пользователь
- 402 – Неизвестный метод
- 403 – Клиент с указанным pid не найден в пределах аккаунта указанного пользователя
- 405 – Отсутствуют параметры - pid контакта
- 406 – Удаление контакта невозможно - есть сделки