Интеграция через API

Материал из DELIVERYCRM WIKI
Перейти к навигации Перейти к поиску

Описание метода добавления треков

URL: http://apilr2.r-lab.biz/addtrack.ashx Формат передачи данных: JSON Метод: POST Внимание! Если сервис не доступен, попробуйте повторить попытку запроса через 5 минут. Если проблема сохраняется, попробуйте резервный адрес http://api-r-lab-b.1gb.ru В случае если сервис не доступен более 20 минут, обратитесь в нашу техническую поддержку.

Пример контейнера с данными запроса: {

  "trackingUserId":1,
  "trackingRequestKey":"8e093b01b18e3272a7d615704cc1502a",
  "testMode":false,
  "trackingData":[{
        "trackingUserClientPhone":"79160000000",
        "trackingUserClientTrack":"19527937484546",
        "trackingUserClientEmail":"support@r-lab.biz",
        "trackingUserClientName":"Дмитрий",
        "trackingUserClientItemCost":123.45,
        "sendToUserEmailFullTracking":false,
        "sendToAdminEmailFullTracking":false,
        "trackingUserClientOrderNumber":"4321",
        "trackingUserClientDescription":""
     },
     {"trackingUserClientPhone":"79150000000",
        "trackingUserClientTrack":"63010828068631",
        "trackingUserClientEmail":"support@r-lab.biz",
        "trackingUserClientName":"Василий",
        "trackingUserClientItemCost":623.12,
        "sendToUserEmailFullTracking":false,
        "sendToAdminEmailFullTracking":false,
        "trackingUserClientOrderNumber":"4331",
        "trackingUserClientDescription":""
     }]

}

Описание свойств контейнера запроса:
Свойство Тип Описание Значение может быть пустым
trackingUserId integer id пользователя нет
trackingRequestKey string md5 hash запроса ( id пользователя :все номера треков без разделитей:ключ пользователя). Пример: 1:1952793748454663010828068631:3c6e0b8a9c15224a8228b9a98ca1531d нет
testMode boolean В тестовом режиме (true) трекинг номера не добавляются в базу, происходит только проверка запроса нет
trackingData JSON array Содержит массив с трекинг номерами и данными клиента нет
trackingUserClientPhone string Номер мобильного телефона клиента в федеральном формате. Пример: 79160000000. Если SMS отправлять не нужно, указывайте номер 79000000000 нет
trackingUserClientTrack string Трекинг номер почтового отправления нет
trackingUserClientEmail string E-Mail клиента (если значение пустое, оповещения на e-mail отправляться не будут) да
trackingUserClientName string Имя или ФИО клиента да
trackingUserClientItemCost decimal Стоимость товаров да (может быть нулем)
sendToAdminEmailFullTracking boolean Если значение свойства true, то при каждом изменении статуса почтового отправления на e-mail администратора магазина (указанный при регистрации в http://www.отследить-посылку.рф) будет отправлять письмо с информацией о статусе. нет