Home

API для клиентского виджета

API и клиентский виджет все еще находятся в разработке. Пожалуйста, будьте готовы к небольшим изменениям.

Документация также претерпевает изменения. Следите за обновлениями.

HTTP headers

Должны устанавливаться во всех запросах.

Name	Type	Required	Description
Hive-Context	number	true	Контекст (должен быть заранее известен пользователю API)
Accept-Language	string	false	Локаль (должна удовлетворять регулярному выражению “^([a-zA-Z]{1,8})(?:[_-]([a-zA-Z]{1,8}))?”)

Запросы

Статус API

Система активно разрабатывается как и API, которые она предоставляет. Для каждого элемента API определен его статус, определяющий степень его стабильности/готовности для использования:

• experimental – Еще не достаточно хорошо протестированы, велика вероятность каких-либо изменений в форматах запросов/ответов, также возможно изъятие функции из API;
• unstable – API протестирован командой разработки, возможны мелкие изменения в форматах запросов (с большой вероятностью без потери обратной совместимости при переходе от experimental к unstable);
• stable – API зафиксирован. Изменения могут быть внесены только при условии сохранения обратной совместимости. Если сохранение обратной совместимости невозможно, будет разработана новая версия интерфейсного вызова.

Method	URI	Status	Page Link
GET	/api/client/web/1.0/address/address	experimental	Поиск адреса
GET	/api/client/web/1.0/address/nearest	experimental	Поиск адресной точки
GET	/api/client/web/1.0/address/point	experimental	Поиск адреса по координатам
GET	/api/client/web/1.0/tariff/options	experimental	Получение опций тарифа
POST	/api/client/web/1.0/order/estimate	experimental	Предварительная оценка заказа
POST	/api/client/web/1.0/order/submit	experimental	Заведение заказа
GET	/api/client/web/1.0/order/confirm	experimental	Подтверждение заказа
GET	/api/client/web/1.0/order/status	experimental	Получение статуса заказа

Ответ от сервера

Если запрос был успешно выполнен, ответ вернется с кодом 200.

Если же в ходе выполнения запроса произошла ошибка, сервер вернет ответ с кодом 400 (пользовательская ошибка) или 500 (внутренняя ошибка сервера).
Тело ответа в данном случае будет содержать json следующего формата:

Name	Type	Required	Description
code	number	true	Код ошибки
message	string	true	Локализованное описание ошибки

Общие ошибки

Code	Description
-10001	Отсутствует обязательный параметр
-10002	Невалидный параметр
-10003	Невалидный JSON в теле запроса