Добавление отслеживания

Пример на php с использованием CURL

Адрес

Методы

Параметры метода

Варианты ответа

При успешном добавлении трека сервер ответит:

В данном случае: 100 - успешный ответ сервера, 2123 - ID отправления (на следующей строке).

Если в ходе добавления возникла какая-либо ошибка сервер ответит следующий образом:

201 - Неправильно введен телефон, 204 - Не хватает денежных средств

Получение состояния баланса

Пример на php без CURL

Адрес

Методы

Параметры метода

Варианты ответа

При успешном добавлении трека сервер ответит:

В данном случае: 100 - успешный ответ сервера, 1560 - баланс счета в рублях.

Если в ходе добавления возникла какая-либо ошибка сервер ответит следующий образом:

200 - Неправильно введен api_id

Получение состояния баланса звонков

Пример на php без CURL

Адрес

Методы

Параметры метода

Варианты ответа

При успешном добавлении трека сервер ответит:

В данном случае: 100 - успешный ответ сервера, 1560 - баланс счета в рублях, 520 - количество доступных звонков.

Если в ходе добавления возникла какая-либо ошибка сервер ответит следующий образом:

200 - Неправильно введен api_id

Остановка отслеживания трека

Пример на php без CURL

Адрес

Методы

Параметры метода

Варианты ответа

При успешном добавлении трека сервер ответит:

В данном случае: 100 - успешный ответ сервера

Если в ходе добавления возникла какая-либо ошибка сервер ответит следующий образом:

200 - Неправильно введен api_id

Получение информации об отслеживании

Пример на php без CURL

Адрес

Методы

Параметры метода

Варианты ответа

При успешном запросе  сервер ответит:

100

{
"0":{
"date":"18.03.2016 10:44",
"operation":"Вручение",
"text":"Вручение адресату",
"geo":"",
"index":""
},
"1":{
"date":"18.03.2016 10:44",
"operation":"Возврат",
"text":"Истек срок хранения",
"geo":"",
"index":""
},
"2":{
"date":"17.03.2016 19:54",
"operation":"Возврат",
"text":"Истек срок хранения",
"geo":"",
"index":""
},
"3":{
"date":"17.03.2016 19:54",
"operation":"Вручение",
"text":"Вручение адресату",
"geo":"",
"index":""
},
"4":{
"date":"17.03.2016 15:46",
"operation":"Возврат",
"text":"Истек срок хранения",
"geo":"",
"index":""
},
"5":{
"date":"04.03.2016 15:32",
"operation":"Вручение",
"text":"Вручение адресату",
"geo":"",
"index":""
},
"6":{
"date":"04.03.2016 08:45",
"operation":"Обработка",
"text":"Прибыло в место вручения",
"geo":"Краснодар 15",
"index":"350015"
},
"7":{
"date":"04.03.2016 07:21",
"operation":"Обработка",
"text":"Покинуло сортировочный центр",
"geo":"Краснодар Почтамт",
"index":"350999"
},
"8":{
"date":"03.03.2016 05:22",
"operation":"Обработка",
"text":"Покинуло сортировочный центр",
"geo":"Краснодар МСЦ",
"index":"350960"
},
"9":{
"date":"29.02.2016 06:50",
"operation":"Обработка",
"text":"Покинуло сортировочный центр",
"geo":"Самара МСЦ",
"index":"443960"
},
"10":{
"date":"29.02.2016 00:53",
"operation":"Обработка",
"text":"Прибыло в сортировочный центр",
"geo":"Самара МСЦ",
"index":"443960"
},
"11":{
"date":"28.02.2016 14:22",
"operation":"Обработка",
"text":"Покинуло сортировочный центр",
"geo":"Оренбург МСЦ",
"index":"460960"
},
"12":{
"date":"28.02.2016 14:11",
"operation":"Обработка",
"text":"Прибыло в сортировочный центр",
"geo":"Оренбург МСЦ",
"index":"460960"
},
"13":{
"date":"27.02.2016 12:08",
"operation":"Обработка",
"text":"Покинуло место приёма",
"geo":"Оренбург 3",
"index":"460003"
},
"14":{
"date":"27.02.2016 12:08",
"operation":"Прием",
"text":"Партионный",
"geo":"Оренбург 3",
"index":"460003"
},
"status":4,
"weight":"0.07",
"value":"1040",
"price":"1040"
}

В данном случае: 100 - успешный ответ сервера, на второй строке публикуется json-массив данных, содержащий следующие данные: status - Статус заказа (0 - В пути, 1 - На почте, 2 - Вручен, 3 - Возврат)
weight - вес посылки (кг)
value - объявленная ценность (руб.)
price - наложенный платеж (руб.)
Далее расположен массив с данными для каждого из статусов (date, operation, text, geo, index).

Если в ходе добавления возникла какая-либо ошибка сервер ответит следующий образом:

200 - Неправильно введен api_id

Получение информации о наложенном платеже

Пример на php без CURL

Адрес

Методы

Параметры метода

Варианты ответа

При успешном запросе  сервер ответит:

100
[
{
"number":"19721",
"event":"Приём",
"date":"1456141839",
"indexFrom":"143007",
"indexTo":"344000",
"summa":"1580"
},
{
"number":"19721",
"event":"Оплата",
"date":"1456486213",
"indexFrom":"344000",
"indexTo":"344000",
"summa":"1580"
}
]

В данном случае: 100 - успешный ответ сервера, на второй строке публикуется json-массив данных. Содержащий следующие данные (number, event, date, indexFrom, indexTo, summa) для каждого из статусов.

Если в ходе добавления возникла какая-либо ошибка сервер ответит следующий образом:

200 - Неправильно введен api_id

Получение информации о СМС

или:

Пример на php без CURL

Адрес

Методы

Параметры метода

или 

Варианты ответа

При успешном запросе  сервер ответит:

100
[
{
"sms_id":"284442",
"date":"1411464241",
"text":" Заказ прибыл в ваше почтовое отделение 682738. Трек-номер: 46000371031513 Сумма: 880 руб.",
"status_code":"103",
"status_text":"Доставлено"
},
{
"sms_id":"284407",
"date":"1411464221",
"text":"gdfg dfgdfd g",
"status_code":"103",
"status_text":"Доставлено"
}
]

В данном случае: 100 - успешный ответ сервера, на второй строке публикуется json-массив данных. Содержащий следующие данные (sms_id - id смс, date - дата, text - текст, status_code - статус в кодовом формате, status_text - статус сообщения в текстовом формате) для каждого из сообщений.

Таблица status_code:

Если в ходе добавления возникла какая-либо ошибка сервер ответит следующий образом:

200 - Неправильно введен api_id

Получение информации о совершенных звонках

или:

Пример на php без CURL

Адрес

Методы

Параметры метода

или 

Варианты ответа

Таблица status_code:

При успешном запросе  сервер ответит:

100
[
{
"call_id":"141",
"date":"1402388153",
"status":"Звонок исполнен, прерван абонентом",
"status_code":"105",
"duration":"8"
}
]

В данном случае: 100 - успешный ответ сервера, на второй строке публикуется json-массив данных. Содержащий следующие данные (call_id - id звонка, date - дата, text - текст, status - статус, duration - длительность звонка в секундах) для каждого из звонка.

Если в ходе добавления возникла какая-либо ошибка сервер ответит следующий образом:

200 - Неправильно введен api_id

Получение информации об отправленных E-mail

или:

Пример на php без CURL

Адрес

Методы

Параметры метода

или 

Варианты ответа

При успешном запросе  сервер ответит:

100
[
{
"email_id":"120163",
"date":"1433531881",
"to":"vyacheslav.pavlov@gmail.com",
"from":"support@liveinform.ru",
"subject":"Ваш заказ прибыл в место вручения",
"status":"Открыто",
"status_date":"1433567022",
"url":""
},
{
"email_id":"119728",
"date":"1433499508",
"to":"vyacheslav.pavlov@gmail.com",
"from":"support@liveinform.ru",
"subject":"Ваш заказ 3213 отправлен!",
"status":"Открыто",
"status_date":"1433499624",
"url":""
}
]

В данном случае: 100 - успешный ответ сервера, на второй строке публикуется json-массив данных. Содержащий следующие данные (email_id - id письма, date - дата отправки, to - кому, from - от кого, subject - тема письма, status - статус (доставлено, открыто, в спаме, клик и т.п.), status_date - дата последнего события, url - переход по ссылке) для каждого из писем.

Если в ходе добавления возникла какая-либо ошибка сервер ответит следующий образом:

200 - Неправильно введен api_id

Callback-оповещения о новых статусах заказа

В разделе callback вы можете указать адрес скрипта, на который будут отправляться оповещения от нашего сервиса. Указанный скрипт будет вызываться нашим сервером после каждого получения нового статуса отправления.

Переменная $_POST['data'] содержит в себе json-массив с полной информацией о заказе: параметры заказа, трекинг, СМС, звонки и E-mail.

Ваш скрипт должен вернуть HTTP-статус 200, в противном случае наш сервер будет пытаться отправить информацию повторно каждые 15 минут (максимальное количество попыток - 10).

			 
{  
   "order_id":"1389374", // ID заказа в системе LiveInform 
   "phone":"89603560390", // Телефон
   "track":"15000098940051", // Трек-номер
   "email":"support@liveinform.ru", // E-mail
   "lastname":"Иванов", // Фамилия
   "firstname":"Александр", // Имя
   "type":"1", // Тип отслеживания (1 или 2)
   "account_order_id":"123", // Номер заказа
   "index":"410062", // Индекс место вручения
   "address":"САРАТОВ, САРАТОВСКАЯ ОБЛАСТЬ", // Регион
   "comment":"Комментарий к заказу", // Комментарий к заказу
   "status":"0", // Статус отслеживания (0 - индексируется, 1 - не индексируется)
   "track_status":"1", // Статус заказа (0 - в пути, 1 - в месте вручения, 2 - вручен, 3 - возврат,  4 - остановлен)
   "weight":"0.42", // Вес отправления, кг
   "value":"1853", // Объявленная ценность, руб.
   "price":"1853", // Наложенный платеж, руб.
   "additional1":"Допполе 1", // Дополнительное поле 1
   "additional2":"Допполе 2", // Дополнительное поле 2
   "additional3":"Допполе 3", // Дополнительное поле 3
   "tags":"Метка 1, Метка 2", // Метки
   "tracking": [ // Данные о трекинге
      {
         "date": "1471866678",
         "operation": "Обработка",
         "text": "Прибыло в место вручения",
         "geo": "Нижнекамск 14",
         "index": "423584"
      },
      {
         "date": "1471841747",
         "operation": "Обработка",
         "text": "Покинуло сортировочный центр",
         "geo": "Нижнекамск Почтамт",
         "index": "423599"
      },
      {
         "date": "1471729176",
         "operation": "Обработка",
         "text": "Покинуло сортировочный центр",
         "geo": "Казань МСЦ",
         "index": "420960"
      },
      {
         "date": "1471676759",
         "operation": "Обработка",
         "text": "Прибыло в сортировочный центр",
         "geo": "Казань МСЦ",
         "index": "420960"
      },
      {
         "date": "1471417068",
         "operation": "Обработка",
         "text": "Покинуло сортировочный центр",
         "geo": "Ярославль МСЦ",
         "index": "150960"
      }
   ],
   "sms": [ // Данные об отправленных СМС
      {
         "sms_id": "5430866",
         "date": "1472551200",
         "text": "Алекснадр Иванов, ваш заказ 123 отправлен. Трек-номер: 15000098940051",
         "status_code": "100",
         "status_text": "В очереди"
      },
      {
         "sms_id": "5430872",
         "date": "1472551200",
         "text": "Алекснадр Иванов, ваш заказ 123 прибыл в место вручения 423584. Сумма к оплате 1853 руб.",
         "status_code": "",
         "status_text": ""
      } 
   ],
   "calls": [ // Данные о совершенных звонках
      {
         "call_id": "610014",
         "date": "1472549813",
         "text": "Здравствуйте, Алекснадр. Ваш заказ 123 в интернет-магазине shop.ru отправлен",
         "status": "Звонок исполнен полностью",
         "duration": "9",
      }
   ],
   "emails": [ // Данные об отправленных E-mail
      {
         "email_id": "610014",
         "date": "1472549813",
         "to": "support@liveinform.ru",
         "from": "support@shop.ru",
         "subject": "Ваш заказ отправлен",
         "status": "Отправка",
         "status_date": "0",
         "url": ""
      }
   ]
   
}
			

Dashboard - получение общей информации по статусам

Пример на php с использованием CURL

Пример на php без CURL

Адрес

Методы

Параметры метода

Варианты ответа

При успешном запросе сервер ответит:

100
{
"ontheway":{
"sum":3,
"percent":"1.5%"
},
"ready":{
"sum":0,
"percent":"0%"
},
"welldone":{
"sum":172,
"percent":"84.7%"
},
"vozvrat":{
"sum":28,
"percent":"13.8%"
},
"all":{
"summa":203,
"percent":"100%"
}
}

В данном случае: 100 - успешный ответ сервера, на второй строчке в формате json: ontheway - в пути, ready - в месте вручения, welldone - врученные, return - возвраты, all - всего. Переменная summa отражает количество заказов по данному статусу, а percent процентное соотношение к общему числу заказов за выбранный период.

Если в ходе добавления возникла какая-либо ошибка сервер ответит следующий образом:

200 - Неправильно введен api_id

Черный список

Проверка данных (телефон или E-mail) клиента на наличие невыкупленных заказов с наложенном платежом.

Пример на php без CURL

Адрес

Методы

Параметры метода

или

Варианты ответа

Если данные найдены в нашей базе:

В данном случае: 100 - успешный ответ сервера, 1 - найдено совпадение.

Если данные отсутствуют в нашей базе:

100 - успешный ответ сервера, 0 - совпадений нет.

Если в ходе добавления возникла какая-либо ошибка сервер ответит следующий образом:

200 - Неправильно введен api_id

Отправка СМС

Пример на php без CURL

Адрес

Методы

Параметры метода

Вместо переменной phone можно использовать order_id:

Варианты ответа

При успешном добавлении СМС сервер ответит:

В данном случае: 100 - успешный ответ сервера

Если в ходе операции возникла какая-либо ошибка, сервер выведет номера ошибок:

200 - Неправильно введен api_id

Совершение звонка

Пример на php без CURL

Адрес

Методы

Параметры метода

Вместо переменной phone можно использовать order_id:

Варианты ответа

При успешном добавлении звонка сервер ответит:

В данном случае: 100 - успешный ответ сервера

Если в ходе операции возникла какая-либо ошибка, сервер выведет номера ошибок:

200 - Неправильно введен api_id

201 - Неправильно введен телефон