Home

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

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}))?”)

Запросы

• Поиск адреса
• Поиск адресной точки
• Поиск адреса по координатам
• Получение опций тарифа
• Предварительная оценка заказа
• Заведение заказа
• Подтверждение заказа
• Получение статуса заказа

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

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

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

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

Общие ошибки

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