Запросы 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 — в этом случае партнер должен считать, что данные точки не были добавлены/обновлены, и должен прислать корректные данные при очередной синхронизации.

Cardsmobile Place Info API - Previous

Синхронизация списка точек обслуживания

Next - Cardsmobile Check-In API

Общие сведения

Last modified 5mo ago

Copy link

On this page

post

Cинхронизация списка точек обслуживания

get

Запрос статуса обработки списка