Описание назначения/Order Life Cycle
Скачать 124.71 Kb.
|
CLIENT ORDER REQUEST API        История документа
НАЗНАЧЕНИЕ API Client Order Request Api (далее просто API) предназначен для регистрации конечного действия пользователя(заказа) в системе CallTouch . Данное действие позволяет клиентам CallTouch, связать сессионные параметры пользователя (ключевые слова поиска, источник, тип источника, сессию гугл аналитикс) с его конечным целевым действием(например таким как покупка товара ) . API позволяет осуществлять регистрацию заказов, поиск , поддержку жизненного цикла заказа, что помогает оценить процент не завершенных заказов или заказов, которые были отклонены. Статусы заказа NOT_SET (заказ был инициирован пользователем, но не был оформлен) PENDING(заказ был оформлен, но еще не подтвержден системой) APPROVED(заказ оплачен и подтвержден системой) CANCELED(заказ отменен оператором системы или пользователем) REJECTED(заказ отклонен системой) COMPLETED(заказ доставлен клиенту/ завершен) Жизненный цикл заказа CANCELED NOT_SET PENDING APPROVED COMPLETED REJECTED ФОРМАТ ЗАПРОСОВ РЕГИСТРАЦИЯ ЗАЯВКИ URL: http:// api.calltouch.ru/calls-service/RestAPI/requests/orders/register/ Допустимые типы запроса: GET, POST Параметры:
Для интеграции сессии пользователя необходимо в параметр sessionId устанавливать значение параметра call_value, которое Calltouch передает при ответе на запрос выделения тел. номера для сайта. ОТВЕТ: JSONRequestObject Пример: http:// api.calltouch.ru/calls-service/RestAPI/requests/orders/register/?clientApiId=xxxxxx&requestNumber=1&orderNumber=1&orderSum=1258&fio=Alex&email=alex@calltoch.ru&phoneNumber=8926xxxxxx&personalPhone=false&orderСomment=VseOk РЕГИСТРАЦИЯ ЗАКАЗА ПО ЗВОНКУ URL: http:// api.calltouch.ru/calls-service/RestAPI/orders/register/ Допустимые типы запроса: GET, POST Параметры:
Важным параметром является orderDate, он определяет время заказа. Предполагается, что заказ составляется во время разговора по телефону с клиентом и данная дата является временем заведения заказа на момент звонка. Это дата будет использоваться для поиска звонка для связки. Критерий определения Дата звонка <= Дата заказа <= Дата звонка + Длительность звонка + linkTimeThreshold(допустимый порог) Телефон звонившего должен совпадать с phoneNumber. ОТВЕТ: JSONOrderObject Пример: http://api.calltouch.ru/calls-service/RestAPI/orders/register/?clientApiId=xxxxx&orderSum=780 &fio=Александр&phoneNumber=79187665050&orderComment=test test&orderNumber=MK-908777&orderDate=22.04.2014 15:09:44 ПОИСК ЗАЯВКИ URL: http://api.calltouch.ru/calls-service/RestAPI/requests Допустимые типы запроса: GET
ОТВЕТ: Array(JSON Request Object) Пример: http:// api.calltouch.ru/calls-service/RestAPI/requests?clientApiId=xxxx&dateFrom=01/02/2013&dateTo=02/14/2013 ВЫБОР ЗАЯВКИ URL: http:// api.calltouch.ru/calls-service/RestAPI/requests/{requestNumber} Допустимые типы запроса: GET
ОТВЕТ: JSON Request Object Пример: http:// api.calltouch.ru/calls-service/RestAPI/requests/1?clientApiId=xxxx ВЫБОР ЗАКАЗА URL: http:// api.calltouch.ru/calls-service/RestAPI/requests/orders/{orderNumber} Допустимые типы запроса: GET
ОТВЕТ: JSON Order Object Пример: http:// api.calltouch.ru/calls-service/RestAPI/requests/orders/2?clientApiId=xxxx ПОДТВЕРЖДЕНИЕ ЗАКАЗА(STAUS=APPROVED) Допустимые типы запроса: GET
ОТВЕТ: JSON Order Object Пример: http:// api.calltouch.ru/calls-service/RestAPI/requests/orders/2/approve?clientApiId=xxxx ОТМЕНА ЗАКАЗА(STAUS=CANCELED) Допустимые типы запроса: GET
ОТВЕТ: JSON Order Object Пример: http:// api.calltouch.ru/calls-service/RestAPI/requests/orders/2/cancel?clientApiId=xxxx ОШИБКА В ОБРАБОТКЕ ЗАКАЗА(STAUS=REJECTED) Допустимые типы запроса: GET
ОТВЕТ: JSON Order Object Пример: http:// api.calltouch.ru/calls-service/RestAPI/requests/orders/2/reject?clientApiId=xxxx ОШИБКА В ОБРАБОТКЕ ЗАКАЗА(STAUS=COMPLETED) Допустимые типы запроса: GET
ОТВЕТ: JSON Order Object Пример: http:// api.calltouch.ru/calls-service/RestAPI/requests/orders/2/complete?clientApiId=xxxx ФОРМАТ ОТВЕТОВ - JSONRequestObject Пример запрос: http:// api.calltouch.ru/calls-service/RestAPI/requests/orders/register/?clientApiId=xxxxxx&requestNumber=5399&orderNumber=11225&orderStatus=PENDING&orderSum=1251&fio=Alex&email=alex@calltouch.ru&phoneNumber=79163223554&personalPhone=true ответ: {"requestNumber":"5399","status":"NOT_SET","client":{"fio":"Alex","phones":[{"phoneNumber":"79163223554","phoneType":"PERSONAL"}],"contacts":[{"contactType":"EMAIL","contactValue":"alex@calltouch.ru"}]},"order":{"orderNumber":"11225","orderSum":"1251","orderStatus":"PENDING","orderComments":null},"session":null} - JSON Order Object Пример запрос: http:// api.calltouch.ru/calls-service/RestAPI/requests/orders/2/approve?clientApiId=xxxx ответ: {"orderNumber":"2","orderSum":"1251","orderStatus":"APPROVED","orderComments":null} | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Похожие:
 | Параметр «error 3012» в ответах на запросы «order pre» (Предварительная проверка параметров заказа и расчет стоимости) и «order new»... | | |
|  | Проект ориентирован на предоставление услуг по физическому укреплению здоровья населения | |
| | ||
| В структуру вносится информация о Подразделениях, отделениях лпу, оказывающих медицинские услуги населению, о разбиении на участки... | | В структуру вносится информация о Подразделениях, отделениях лпу, оказывающих медицинские услуги населению, о разбиении на участки... |
| Музыкальный альбом "Музыка белых", автор Музыкальная группа Order, решение вынесено Первомайским районным судом г. Омска от 23. 11.... | | Описание образовательной деятельности по профессиональной коррекции нарушений развития детей |