Программно HTTP API предоставляется модулем web2 (Веб-сервер 2.0).
См. Руководство Администратора, раздел Настройка Сервера для подключения Клиентов с помощью модуля Веб-сервер 2.0. |
HTTP API позволяет использовать следующие функции:
В примерах, приводимых в данном разделе, используются следующие обозначения:
Далее описание будет опускаться там, где действие запроса понятно из контекста.
URL, id объектов и расширения файлов чувствительны к регистру. |
Дата и время указываются в формате RFC3339, подробнее см. http://www.ietf.org/rfc/rfc3339.txt |
По умолчанию формат ответа JSON. Включение ответа по умолчанию в формате XML осуществляется на панели настройки объекта Веб-сервер 2.0 (см. Настройка типа ответа на запросы HTTP API по умолчанию). Также формат ответа может быть явно указан в заголовке Accept, например application/json или application/xml. Указанный формат ответа в запросе имеет больший приоритет, чем заданный на панели настройки объекта Веб-сервер 2.0 формат ответа по умолчанию.
Для выполнения кросс-доменных запросов, или если к необходимым заголовкам в ответе доступа нет (например, в связи с политикой CORS браузера), необходимо в запросе указать заголовок Origin (домен сайта, с которого происходит запрос). В таком случае в ответе будет содержаться заголовок Access-Control-Allow-Origin, который указывает на разрешение доступа к ресурсу с указанного домена кросс-сайтовым способом. Заголовок Access-Control-Allow-Origin: * означает, что к ресурсу можно получить доступ с любого домена кросс-сайтовым способом.