Помимо точек доступа API, описанных в предыдущей статье, в платформе существует ещё несколько методов взаимодействия. Они также являются защищенными парой закрытого и открытого ключа приложения.
Закрытый и открытый ключ приложения В качестве основных параметров POST запросов REST API является appID и appSecret.
Получить их можно через Web-интерфейс платформы в разделе Настройки → Интеграции → Application keys.
Получить объекты определенной структуры. Их можно фильтровать, сортировать и выдавать постранично.
{"result": {"list": [{"sid": 1910,"objectID": "1","dateCreated": "2015-05-23T09:21:49Z","dateChanged": "2015-08-19T08:19:07Z","obj": {"id": "1","first_name": "Иван"}}],"pageInfo": {"currentPage": 0,"pageSize": 10,"totalPage": 1,"tableSize": 1,"currentPageSize": 1}},"status": "OK"}
Пример{"operator": "OR","field": "","value": "","exp": "","filters": [{"operator": "AND","field": "tmc_list_id.category.id","value": "30078fd3-213f-459f-8668-c321efc762c1","exp": "=="},{"operator": "AND","field": "tmc_list_id.category.id","value": "Телефоны","exp": "=="}]}
Метод сохраняет необходимый файл (multipart/form-data) во внутреннее файлохранилище (структура fileUpload). Сам файл передаётся в Body с типом form-data, где key = file, value = загруженный файл.
Реализация происходит по средствам отправки POST запроса на URL:
{"result": {"id": "626c38c1-1595-47ec-82aa-278256fab6bb","finalFileName": "others/23b69abb-64bf-45df-bbfc-a28631a85b8a.jpg"},"status": "OK"}
Метод осуществляет импорт файла в структуру в формате csv/xls (multipart/form-data) по средствам POST запроса.
Метод будет создавать объекты заданной структуры (название колонок должно совпадать с названием системных полей). От все стилей на листе лучше избавиться. Импортировать можно только 1 лист
{"result": {"insert": 10,"update": 1,"lastObjectID": "3d00ccc3-eb6a-403e-8846-961e38341b49"},"status": "OK"}
Метод забирает метаинформацию о структуре (группы, список, типы полей и т.п.).
{"result": {"groups": [{"id": 1487317233812,"name": "Общая информация"},{"id": 1487317752904,"name": "Счетчики"},{"id": 1492171154945,"name": "Автоматич. ценообразование"},{"id": 1492592314667,"name": "Данные по цене"}],"fields": [{"sysName": "id","dataType": "id","name": "ID","id": "1429106144700","link": "","group": "","tags": "","indexing": false,"ordering": false,"linkIndexFieldSysName": [],},{"sysName": "tmc_list_id","dataType": "arrayLink","name": "Товары","id": "1487078160307","link": "TMC","group": "1487317233812","tags": "","indexing": true,"ordering": false,"linkIndexFieldSysName": ["name","description","category.id"],}],},"status": "OK"}
Порядок полей в ответе может быть установлен путем указания веса в настройках структуры.
Метод позволяет получить обновления объекта после необходимого timeStamp.
{"result": {"list": {"sid": 4611402,"objectID": "b76b8aaf-4ec4-4cf1-9bfe-bafc991a68ce","dateCreated": "2017-05-09T10:12:14Z","dateChanged": "2017-06-02T12:58:14Z","obj": {"id":"test","webUserId": "test"},"version": 1494324734001,}},"status": "OK"}