Метод работы с WEB-ресурсом

Для работы с WEB-ресурсом выполните запрос с помощью API-метода web (перед выполнением запроса определите токен пользователя).

Для аутентификации пользователя API в запросе передаются параметры ресурса и указывается заголовок Authorization:

curl -v '<IP-адрес или DNS-имя сервера>/api/v1/web/<название ресурса>/<путь к ресурсу>' -H 'Authorization: Bearer <токен пользователя>' --header 'Content-Type: application/json' -d '{<запрос к источнику данных>}'

Если необходимо выполнить аутентификацию пользователя API в источнике данных, то в запросе дополнительно укажите заголовок Web-Authorization:

curl -v '<IP-адрес или DNS-имя сервера>/api/v1/web/<название ресурса>/<путь к ресурсу>' -H 'Authorization: Bearer <токен пользователя>' --header 'Content-Type: application/json' --header 'Web-Authorization: Basic <токен пользователя>' -d '{<запрос к источнику данных>}'

Если для источника данных выбран тип аутентификации Kerberos, то в запросе укажите заголовок Accept со значением «text/html»:

curl -v '<IP-адрес или DNS-имя сервера>/api/v1/web/<название ресурса>/<путь к ресурсу>' -H 'Authorization: Bearer <токен пользователя>' --header 'Accept: text/html' --header 'Content-Type: application/json' -d '{<запрос к источнику данных>}'

Подстановка <путь к ресурсу> является необязательной. При использовании подстановки учитывайте следующие особенности:

если в подстановке указан путь к ресурсу, то к источнику данных WEB отправляется запрос в формате:

http://<хост>/<путь к ресурсу>

если в подстановке не указан путь к ресурсу, то к источнику данных WEB отправляется запрос с использованием заданного пути по умолчанию в формате:

http://<хост>/<путь по умолчанию>

если в подстановке не указан путь к ресурсу и не задан путь по умолчанию, то к источнику данных WEB отправляется запрос в формате:

http://<хост>

Примечание. Если GET-параметры ресурса задаются в запросе мобильного клиента и через консоль администратора, то используются только заданные GET-параметры в запросе мобильного клиента.

Пример ответа в формате JSON:

Trying 0.0.0.0...
TCP_NODELAY set
Connected to <IP-адрес или DNS-имя сервера> (0.0.0.0) port 80 (#0)
> GET /api/v1/web/<название ресурса>/<путь к ресурсу> HTTP/1.1
> Host: <IP-адрес или DNS-имя сервера>
> User-Agent: curl/7.55.1
> Content-Type: application/json
> Authorization: Bearer <токен пользователя>
> Accept: text/plain
>
< HTTP/1.1 200 OK
< Server: nginx/1.9.11
< Date: <дата>
< Content-Type: *.*; charset=utf-8
< Content-Length: 139685
< Connection: keep-alive
< Cache-Control: no-cache,no-store,max-age=0,must-revalidate
< Expires: <дата>
< Last-Modified: <дата>
< X-Frame-Options: DENY
< X-Content-Type-Options: nosniff
< Allow: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS, TRACE
< Vary: Origin, Cookie, Accept-Encoding
<
<!DOCTYPE html><ответ от источника данных></html>

См. также:

API сервера | Подключение источников данных