Запросы API
Для синхронизации списка точек обслуживания
Документация перемещена
Информация на этой странице не обновляется и может быть устаревшей.
Наиболее полная и актуальная версия документации для разработчиков доступна по новому адресу:
post
https://<base-URL>
/places/sync
Cинхронизация списка точек обслуживания
{
"places": [ // список точек обслуживания
{
"itemId": "string", // идентификатор точки обслуживания в информационной системе партнера
"placeInfo": { // информация о точке обслуживания
"name": "string", // название точки обслуживания
"address": "string", // адрес точки обслуживания
"phones": [ // телефон(ы) точки обслуживания
{
"type": "string",
"number": "string"
}
],
"schedule": "string", // режим работы
"metroStations": [ // ближайшие станции метро
"string"
],
"type": "string", // тип точки обслуживания
"geoPoint": { // координаты точки обслуживания
"lat": 0, // географическая широта
"lng": 0 // географическая долгота
}
}
}
]
}
- Поле
addressявляется обязательным. - Где применимо, текстовые данные должны передаваться на русском языке в кодировке UTF-8.
Узел Cardsmobile в ответе вернет партнеру идентификатор сессии синхронизации
sessionId — это означает, что обработка переданного партнером списка началась.get
https://<base-URL>
/places/sync/{sessionId}
Запрос статуса обработки списка
С какой периодичностью проверять статус обработки?
Окончанию обработки соответствует статус FINISHED. В среднем обработка списка занимает около минуты. Общая длительность обработки зависит от объема списка и количества изменений.
О позициях, содержащих ошибки:
В финальном ответе (
"status": "FINISHED") все обнаруженные ошибки обработки в случае их наличия будут переданы в массиве errors. Данные о точке обслуживания, содержащие ошибки, отбраковываются сервисом Cardsmobile — в этом случае партнер должен считать, что данные точки не были добавлены/обновлены, и должен прислать корректные данные при очередной синхронизации.