В этой документации описывается интерфейс прикладного программирования на основе REST (API), опубликованный Simply CRM . Он предназначен в качестве справочного документа для всех, кто использует наши API.
Мы рекомендуем вам ознакомиться с руководством, прежде чем пытаться прочитать эту документацию.
Все структурные данные, включая ответ от API, представлены в виде строк JSON.
Каждая сущность имеет специально отформатированный идентификатор, который можно использовать для поиска типа сущности и записи. Create — это тот случай, который не требует идентификатора.
http: //Simply_url/webservice.php? operation = [тип операции] & sessionName = [имя сеанса] & [параметры операции]
В настоящее время Simply CRM поддерживает следующие операции:
- получить вызов
- авторизоваться
- Создайте
- забрать
- Обновить
- Удалить
- синхронизировать
- запрос
- listtypes
- описывать
- выйти
- продление
SessionName
Ключ, который используется для однозначной идентификации текущего сеанса. Эта информация должна отправляться на сервер как часть каждого запроса.
веб-сервис
API веб-службы поддерживает модель безопасности, применяемую в пользовательском веб-интерфейсе Simply.
Процесс входа в систему использует двухэтапную схему запрос / ответ.
Типы данных, используемые API
Все ответы будут иметь формат, показанный ниже. Если запрос обработан успешно, то формат следующий:
Если во время обработки запроса произойдет сбой, вы получите ответ в следующем формате:
Ответ {
успех: Boolean = true
result: Object // Объект Result
} Ответ {
успех: Boolean = false
ошибка: ErrorObject
} ErrorObject {
errorCode: String // Строковое представление типа ошибки
errorMessage: String // Сообщение об ошибке из API
}ErrorCode — это строковое представление типа ошибки.
SimplyObject
SimplyObject — это карта, представляющая содержимое объекта на основе сущности crm. Все справочные поля используют тип идентификатора, который присваивает каждому объекту уникальный номер. Это поле присутствует для всех объектов, извлеченных из базы данных.
Формат идентификатора
objectTypeId 'x' objectId
objectTypeId - идентификатор типа объекта. Он создается уникально для каждой сущности, поддерживаемой API веб-службы, и возвращается в результате операции описания как idPrefix.
objectId - идентификатор объекта в базе данных. Это глобально уникальный идентификатор для объектов данной сущности.
карта
Ассоциативный массив пар ключ-значение. Обычно используется в операции создания.
Отметка времени
Длинное представление количества секунд с эпохи Unix.
Операции
Авторизоваться
Вход в систему — это двухэтапный процесс: сначала мы генерируем уникальный токен, вызывающий getChallenge. А затем используйте этот токен и наш уникальный ключ доступа для создания идентификатора сеанса, который действует как идентификатор аутентификации.
400. That’s an error.
Your client has issued a malformed or illegal request. That’s all we know.
400. That’s an error.
Your client has issued a malformed or illegal request. That’s all we know.
Формат URL
http: //Simply_url/webservice.php? operation = query & sessionName = [идентификатор сеанса] & query = [строка запроса]
Синхронизировать
Sync вернет объект SyncResult, содержащий сведения об изменениях после modifiedTime.
sync (modifiedTime: Timestamp, elementType: String): SyncResult
Запрос
Тип : ПОЛУЧИТЬ
ModifiedTime: время последней синхронизированной модификации. elementType: это необязательный параметр, если он указан, изменения для этого модуля по истечении заданного времени, в противном случае возвращаются изменения для всех доступных пользователю модулей.
Ответ
SyncResult { updated:[Object] //List of Objects created or modified. deleted:[Id] //List of *Id* of objects deleted. lastModifiedTime:Timstamp //time of the latest change. which can used in the next call to the Sync api to get all the latest changes that the client hasn't obtained. }Это должен быть запрос GET.
Формат URL
http: //Simply_url/webservice.php? operation = sync & sessionName = [идентификатор сеанса] & modifiedTime = [timestamp] & elementType = [elementType]
Выйти
Выйдите из сеанса веб-службы, в результате чего сеанс веб-службы станет недействительным для дальнейшего использования.
logout (): Карта
Тип запроса: GET. Возвращает карту, содержащую ключевое «сообщение» со значением «успешно».
Это должен быть запрос GET.
Формат URL
http: //Simply_url/webservice.php? operation = logout & sessionName = [идентификатор сеанса]
Типы списков
Перечислите имена всех объектов Simply, доступных через API.
listtypes (): Карта
Тип запроса: ПОЛУЧИТЬ
Возвращает карту, содержащую ключевые «типы» со значением, являющимся списком имен объектов Simply.
Это должен быть запрос GET.
Формат URL
http: //Simply_url/webservice.php? operation = listtypes & sessionName = [идентификатор сеанса]
Описывать
Получить информацию о типе данного объекта Simply.
описать (elementType: String): DescribeResult
Тип запроса: ПОЛУЧИТЬ
elementType: имя типа описываемого объекта Simply.
Возвращает экземпляр DescribeResult.
Это должен быть запрос GET.
Формат URL
Продлить сеанс
Расширяет текущий веб-сеанс Simply до веб-службы и возвращает идентификатор сеанса веб-службы.
extensionsession (имя пользователя: String): LoginResult
Тип запроса: POST
имя пользователя: просто имя пользователя.
Это должен быть запрос POST.
Формат URL
http: //Simply_url/webservice.php? operation = extensionsession
CRM-сущности
Далее следует список сущностей CRM, предоставляемых API.
| Имя | Описание |
| Календарь | Модуль «Календарь» используется для управления делами, событиями и встречами. |
| Ведет | Модуль Leads используется для отслеживания потенциальных клиентов. |
| учетные записи | Модуль «Учетные записи» используется для управления отдельными лицами или организациями, связанными с вашим бизнесом. |
| Контакты | Модуль «Контакты» используется для управления людьми, которые могут быть связаны с учетной записью. |
| Потенциалы | Модуль Potentials используется для управления возможностями продаж. |
| Продукты | Модуль «Продукты» используется для управления продуктами, которые продает ваша организация. |
| Документы | Модуль «Документы» используется для управления загруженными документами и заметками. |
| Электронные письма | Модуль «Электронная почта» — это почтовый клиент, используемый для управления вашей электронной почтой. |
| HelpDesk | Модуль HelpDesk используется для отслеживания проблем клиентов, таких как отзывы, проблемы и т. Д. |
| Часто задаваемые вопросы | Модуль FAQ используется для управления часто задаваемыми вопросами, которые задают ваши клиенты. |
| Продавцы | Модуль Vendors используется для управления производителями и производителями. |
| ПрайсКниги | Модуль PriceBook используется для управления ценами на продукты. |
| Кавычки | Модуль Quotes используется для управления котировками продуктов. |
| Заказ на покупку | Модуль PurchaseOrder используется для управления и обработки заказов на покупку. |
| Заказ клиента | Модуль SalesOrder используется для управления и обработки заказов на продажу. |
| Выставленный счет | Модуль «Счет-фактура» используется для создания отчетов по счетам-фактурам. |
| Кампании | Модуль Кампании используется для управления маркетинговыми кампаниями. |
| События | Модуль «События» используется для управления такими действиями, как звонки и встречи. |
| Пользователи | Модуль Пользователи используется для управления пользователями CRM. |
| Группы | Группы пользователей в Simply CRM . |
| Валюта | Модуль валюты позволяет администратору определять различные валюты и устанавливать ожидаемые курсы конвертации по отношению к базовой валюте. Эти валюты можно использовать в модуле инвентаризации для поддержки мультивалютности. |
| Папки документов | Модуль DocumentFolders используется для группирования документов. |
Типы полей
Список выбора
Поле, которое может содержать одно из списка значений, и в этом случае карта будет содержать два элемента: picklistValues, который представляет собой список возможных значений, и defaultValue, который является значением по умолчанию для раскрывающегося списка.
| Имя | Описание |
| picklistValues | Представляет список возможных значений. |
| значение по умолчанию | Указывает, какое значение следует использовать в качестве значения по умолчанию для раскрывающегося списка. |
| название | Имя типа поля. |
Справка
Поле, показывающее отношение к другому объекту. Карта типов поля будет содержать другой элемент с именем referTo, который представляет собой массив, содержащий модули, на которые может указывать поле.
Дата и время
Строка, представляющая дату и время, формат основан на формате даты в настройках пользователя.
Дата
Строка, представляющая дату. Карта типов поля будет содержать другой элемент, называемый форматом , который определяет ожидаемый формат значения поля на основе настроек формата даты пользователя.
| Имя | Описание |
| формат | Ожидаемый формат значения поля. |
| название | Имя типа поля. |
Текст
Многострочное текстовое поле.
Время
Строка в формате чч: мм, основанная на настройках формата времени пользователя.
Нить
Однострочное текстовое поле.
Логический
Логическое поле, которое может иметь только значения true или false .
Целое число
Поле недесятичного числа.
Владелец
Поле, используемое для определения владельца поля. Это может быть группа или отдельный пользователь.
Автогенерируемая
Поля, такие как идентификатор объекта, значения которых автоматически генерируются программой Simply.
Электронное письмо
Поле, используемое для хранения идентификаторов электронной почты.
Телефон
Поле для хранения телефонных номеров.
URL
Поле для хранения URL.
Двойной
Поле для чисел с плавающей запятой.
Файл
Поле, используемое для добавления файлов в Simply.
| Имя | Описание |
| maxUploadFileSize | Максимально допустимый размер, разрешенный для загрузки файлов. |
| название | Имя типа поля. |
Пароль
Поле для хранения паролей.
Десятичный
Поле, используемое для чисел с плавающей запятой.
Skype
Поле, используемое для хранения идентификаторов Skype или номеров телефонов.
Мультипиклист
Поле раскрывающегося списка, в котором можно выбрать несколько значений.
Известные проблемы
Синхронизация не работает с модулем «Пользователи» и модулями, не являющимися объектами, такими как «Валюта», «Группы» и т. Д.
Запрос не работает с модулями, не являющимися объектами, такими как валюта, группы и т. Д.
