Получение списка ссылок на документацию

Параметр запроса

Параметр

Описание

Обязательный

language

Язык документации.

Допустимые значения:

cn — китайский,

de — немецкий,

en — английский,

es — испанский,

fr — французский,

it — итальянский,

ja — японский,

kk — казахский,

pl — польский,

ru — русский,

uk — украинский.

нет

 

Если на Сервере Dr.Web нет какого-то документа на языке, указанном в запросе, тогда в ответе будет дана ссылка на английскую либо русскую версию этого документа.

 

Пример запроса

https://192.168.1.1:9081/api/server/pdfdoc.ds?language=es

Ниже представлены примеры ответов в формате XML и в формате JSON.

 

Ответ в формате XML

<drweb-es-api api_version="4.3.2" timestamp="1587328217" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">

  <docs>
    <admin>
        <doc title="Administrator Manual" file="admin-manual.pdf" link="/pdf/en/admin-manual.pdf"/>

        <doc title="Installation Manual" file="install-manual.pdf" link="/pdf/es/install-manual.pdf"/>

        <doc title="Appendices" file="appendices.pdf" link="/pdf/en/appendices.pdf"/>

        <doc title="Anti-virus Network Quick Installation Guide" file="quick-install.pdf" link="/pdf/es/quick-install.pdf"/>

        <doc title="Dr.Web Server Database Manual" file="database-manual.pdf" link="/pdf/en/database-manual.pdf"/>

        <doc title="Web API Manual" file="web-api.pdf" link="/pdf/en/web-api.pdf"/>
    </admin>

    <manager>
        <doc title="Managing the workstations under Windows" file="agent-windows.pdf" link="/pdf/en/agent-windows.pdf"/>

        <doc title="Managing the workstations under macOS" file="agent-macos.pdf" link="/pdf/en/agent-macos.pdf"/>

        <doc title="Managing the workstations under Android" file="agent-android.pdf" link="/pdf/en/agent-android.pdf"/>

        <doc title="Managing Dr.Web for Linux" file="agent-linux.pdf" link="/pdf/en/agent-linux.pdf"/>

        <doc title="Managing Microsoft Exchange Server" file="agent-exchange.pdf" link="/pdf/en/agent-exchange.pdf"/>

        <doc title="Managing Dr.Web for UNIX File Servers" file="agent-unix-fs.pdf" link="/pdf/en/agent-unix-fs.pdf"/>

        <doc title="Managing Dr.Web for UNIX Mail Servers" file="agent-unix-ms.pdf" link="/pdf/en/agent-unix-ms.pdf"/>

        <doc title="Managing Dr.Web for UNIX Internet Gateways" file="agent-unix-igw.pdf" link="/pdf/en/agent-unix-igw.pdf"/>
    </manager>

    <user>
        <doc title="Dr.Web Agent for Windows" file="user-manual-windows.pdf" link="/pdf/en/user-manual-windows.pdf"/>
    </user>
  </docs>
</drweb-es-api>

 

Описание параметров ответного XML

Элемент <docs /> содержит список ссылок документов к продукту Dr.Web Enterprise Security Suite 13.0.

•Вложенные элементы элемента <docs />:

Элемент

Описание

<admin />

Перечень Руководств администратора Сервера Dr.Web

<manager />

Перечень Руководств администратора по управлению станциями

<user />

Перечень Руководств пользователя станций

Руководство по Web API относится к группе документов <admin />.

▫Элемент <doc /> вложенных элементов <admin />, <manager /> и <user /> содержит параметры конкретного документа.

Атрибуты элемента <doc />:

Атрибут

Описание

title

Наименование документа

file

Имя файла документа в формате PDF

link

Ссылка на документ, размещенный на Сервере Dr.Web

 

Ответ в формате JSON

{ "head": {
    "status": true,

    "timestamp": 1588773342,

    "api": {
      "version": 40302,
      "versionString": "4.3.2"},

    "server": {
      "name": "192.168.1.1",

      "version": "13.00.0.202005090",
      "uuid": "78b77680-8080-11ea-701a-44a527d9115c"}},

  "data": {
    "admin": [
        {"file": "admin-manual.pdf",
         "link": "/pdf/en/admin-manual.pdf",
         "title": "Administrator Manual"},

        {"file": "install-manual.pdf",
         "link": "/pdf/es/install-manual.pdf",
         "title": "Installation Manual"},

        {"file": "appendices.pdf",
         "link": "/pdf/en/appendices.pdf",
         "title": "Appendices"},

        {"file": "quick-install.pdf",
         "link": "/pdf/es/quick-install.pdf",
         "title": "Anti-virus Network Quick Installation Guide"},

        {"file": "database-manual.pdf",
         "link": "/pdf/en/database-manual.pdf",
         "title": "Dr.Web Server Database Manual"},

        {"file": "web-api.pdf",
         "link": "/pdf/en/web-api.pdf",
         "title": "Web API Manual"}],

    "manager": [
        {"file": "agent-windows.pdf",
         "link": "/pdf/en/agent-windows.pdf",
         "title": "Managing the workstations under Windows"},

        {"file": "agent-macos.pdf",
         "link": "/pdf/en/agent-macos.pdf",
         "title": "Managing the workstations under macOS"},

        {"file": "agent-android.pdf",
         "link": "/pdf/en/agent-android.pdf",
         "title": "Managing the workstations under Android"},

        {"file": "agent-linux.pdf",
         "link": "/pdf/en/agent-linux.pdf",
         "title": "Managing Dr.Web for Linux"},

        {"file": "agent-exchange.pdf",
         "link": "/pdf/en/agent-exchange.pdf",
         "title": "Managing Microsoft Exchange Server"},

        {"file": "agent-unix-fs.pdf",
         "link": "/pdf/en/agent-unix-fs.pdf",
         "title": "Managing Dr.Web for UNIX File Servers"},

        {"file": "agent-unix-ms.pdf",
         "link": "/pdf/en/agent-unix-ms.pdf",
         "title": "Managing Dr.Web for UNIX Mail Servers"},

        {"file": "agent-unix-igw.pdf",
         "link": "/pdf/en/agent-unix-igw.pdf",
         "title": "Managing Dr.Web for UNIX Internet Gateway"}],

    "user": [
        {"file": "user-manual-windows.pdf",
         "link": "/pdf/en/user-manual-windows.pdf",
         "title": "Dr.Web Agent for Windows"}]}}

 

Описание параметров ответного JSON

Блок data содержит список ссылок документов к продукту Dr.Web Enterprise Security Suite 13.0.

Элементы блока data:

Название поля

Описание

admin

Массив с перечнем Руководств администратора Сервера Dr.Web

manager

Массив с перечнем Руководств администратора по управлению станциями

user

Массив с перечнем Руководств пользователя станций

Руководство по Web API относится к группе документов admin.

•Каждый объект массивов admin, manager и user содержит информацию о конкретном документе.

Элементы объектов массивов admin, manager и user:

Название поля

Описание

file

Имя файла документа в формате PDF

link

Ссылка на документ, размещенный на Сервере Dr.Web

title

Наименование документа