Описание API

Сервис Интернет-заказов состоит из двух групп Rest API: подсистема работы с RK7 и подсистема работы с CRM.

BaseUrl - Базовый URL сервера WebDelivery (dlv.ucs.ru).

Для доступа к API RK7:

BaseUrl = dlv.ucs.ru/api/v1/

YML

Для доступа к API CRM:

BaseUrl = https://dlv.ucs.ru/api/v1/crm/

YML

В заголовок каждого запроса (header) необходимо добавить ключ доступа sid. Этот ключ генерируется при авторизации дилера в личном кабинете на dlv.ucs.ru, на странице со списком объектов. Пример:

sid: 21f8221aabd495fad11f73c0500e8cd03821deabe038d82d67cf143d9b31ea21

YML

Важная информация!

Ключ привязан к дилерскому аккаунту. Смена дилера, логина, пароля приводит к автоматической генерации нового sid.
Ключ позволяет получить доступ к ресурсам ресторана R_Keeper и R_Keeper CRM, поэтому не храните его в публичных местах (например, в cookies или в открытом виде на сайте).

При обращении к API CRM в параметрах запроса необходимо передавать номер объекта:

https://dlv.ucs.ru/api/v1/crm/Countries?objectId=<номер объекта>

YML

{
    "data": {
      <Возвращаемые данные>
    },
    "ver": "1.1.15.15",
    "timestamp": "2018-10-03T15:26:02",
    "status": "Ok",
    "errors": [
      {
       "code": "DLW-0023",
       "text": "RK7 error",
       "details": "Not answer from WS"
      }
    ]
    "requestId": "4925c8c968834372a0cbaa7be99e4106"
}

YML

Ответ возвращается в формате json, и состоит из полей:

data - запрашиваемые данные. Опциональное поле. При статусе Err не возвращается.
ver - текущая версия ПО WebDelivery.
timestamp - текущее время, когда пользователю был отдан ответ на запрос. Выдается в формате

yyyy-mm-ddThh:MM:ss

где yyyy- год, mm- месяц, dd- день, hh- час, MM- минута, ss- секунда. Используется время на сервере WebDelivery.

status - статус успешности выполнения возвращаемого ответа. Принимает значения: Ok- в случае успешного выполнения запроса, Err- если произошла ошибка.
errors - список ошибок. Это опциональное поле, возвращаемое только в случае статуса Err. Формат поля- массив. Элементами массива являются структуры, описывающие ошибки, возникшие при выполнении запроса.

Состав структуры данных, описывающих ошибку:

code - код ошибки.
text - текст ошибки. Текст ошибки предваряют префиксы: SAC или CRM- ошибка произошла в CRM; RK7- ошибка сгенерирована кассовым сервером; WS- ошибка на стороне White Server'a; DLW- ошибка сформирована сервером WebDelivery.
details - Пояснения к тексту ошибки, рекомендации по исправлению. Опциональное поле.
requestId - уникальный идентификатор каждого запроса. По этому идентификатору в панели администратора можно выполнить поиск всех записей в журнале событий, связанных с выполнением данного запроса.

Набор API-функций делится на несколько подсистем:

Описание API

Входящий запрос

Общий формат ответа на запрос

Описание API-функций