3. Примеры использования API

При выполнении вызова к Агенту “1С:Линк” обработка сообщения запроса может быть выполнена успешно или завершиться с ошибкой. Ниже в таблице приведены отличительные признаки успешного и ошибочного ответов.

GET /api/applications

Возвращает список информационных баз, добавленных в окно запуска 1С: Предприятие (1cestart)

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

GET http://localhost:<порт-веб-сервиса>/dashboard/product/com.company1c.link.agent.publisher.web/api/applications/

Результат:

 {
    "connectionString": "ws=\"https://<имя-туннеля>.link.1c.ru/<путь-веб-приложения>\";",
    "md5": "ID-информационной-базы",
    "path": null,
    "version": null,
    "ibName": null,
    "paymentId": null,
    "errorString": null,
    "name": "ЛИНК",
    "published": 0,
    "resourceProtected": false,
    "publicationInterfaces": null,
    "limited": false,
    "hidden": false,
    "oldPath": null,
    "winAuth": false,
    "ibProtocol": "ws"
 }
`

GET /api/applications/ID-информационной-базы

Возвращает информацию об информационной базе 1С по строке подключения, URL или хэшу адреса (алгоритм MD5).

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

GET http://localhost: <порт-веб-сервиса> /dashboard/product/com.company1c.link.agent.publisher.web/api/applications/applicationId

Обязательные параметры запроса:

applicationId: ID-информационной-базы

Результат:

{
 "connectionString": "File=\"C:\\Users\\<имя-пользователя>\\Documents\\1C\\<Каталог-ИБ>\";",
 "md5": "ID-информационной-базы",
 "path": null,
 "version": null,
 "ibName": null,
 "paymentId": null,
 "errorString": null,
 "name": "Имя-информационной-базы",
 "published": 0,
 "resourceProtected": false,
 "publicationInterfaces": null,
 "limited": false,
 "hidden": false,
 "oldPath": null,
 "winAuth": false,
 "ibProtocol": "file"
}

GET /api/webapps/

Возвращает список всех опубликованных информационных баз.

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

GET http://localhost: <порт-веб-сервиса> /dashboard/product/com.company1c.link.agent.publisher.web/api/webapps/

Результат

{
 "connectionString": " File=\"C:\\Users\\<имя-пользователя>\\Documents\\1C\\<Каталог-ИБ>\
 "md5": "ID-информационной-базы",
 "path": "Путь-веб-приложения",
 "version": "версия-платформы",
 "ibName": null,
 "paymentId": null,
 "errorString": null,
 "name": "Имя-информационной-базы",
 "published": 1,
 "resourceProtected": false,
 "publicationInterfaces": null,
 "limited": false,
 "hidden": false,
 "oldPath": null,
 "winAuth": false,
 "ibProtocol": "file"
 }

GET /api/webapps/ID-информационной-базы

Возвращает информацию об веб-приложении по строке подключения, URL или хэшу адреса (алгоритм MD5).

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

GET http://localhost:<порт-веб-сервиса>/dashboard/product/com.company1c.link.agent.publisher.web/api/webapps/applicationId

Обязательные параметры запроса:

applicationId: ID-информационной-базы

Результат:

{
 "connectionString": " File=\"C:\\Users\\<имя-пользователя>\\Documents\\1C\\<Каталог-ИБ>\
 "md5": "ID-информационной-базы",
 "path": "Путь-веб-приложения",
 "version": "версия-платформы",
 "ibName": null,
 "paymentId": null,
 "errorString": null,
 "name": "Имя-информационной-базы",
 "published": 1,
 "resourceProtected": false,
 "publicationInterfaces": null,
 "limited": false,
 "hidden": false,
 "oldPath": null,
 "winAuth": false,
 "ibProtocol": "file"
}

PUT /api/webapps/ID-информационной-базы

Публикует информационную базу на встроенном веб-сервере. Для публикации в локальной сети нужно указать сетевые интерфейсы.

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

PUT http://localhost:<порт-веб-сервиса>/dashboard/product/com.company1c.link.agent.publisher.web/api/webapps/applicationId

Обязательные параметры запроса:

applicationId: ID-информационной-базы

Тело запроса:

{
 "connectionString": "File=\"C:\\Users\\<имя-пользователя>\\Documents\\1C\\<Каталог-ИБ>\";",
 "md5": "ID-информационной-базы",
 "path": "Путь-веб-приложения",
 "version": "версия-платформы",
 "ibName": null,
 "paymentId": null,
 "errorString": null,
 "name": "Имя-информационной-базы",
 "published": 2,
 "resourceProtected": false,
 "publicationInterfaces": [
    {
        "nicName": "имя_сетевого_интерфейса",
        "nicDisplayName": null,
        "fqdn": null,
        "port": 28,
        "forInternet": false,
        "rank": 0,
        "active": true,
        "blocked": false,
        "checked": true,
        "id": "id_сетевого_интерфейса",
        "addresses": [
            {
                "ip": "ip-адрес",
                "canonicalName": null,
                "protocol": "http"
            }
        ]
    },
 ],
 "limited": false,
 "hidden": false,
 "ibProtocol": "file",
 "oldPath": null,
 "winAuth": false
}

Результат:

{
 "connectionString": " File=\"C:\\Users\\<имя-пользователя>\\Documents\\1C\\<Каталог-ИБ>\";",
 "md5": "ID-информационной-базы",
 "path": "путь-веб-приложения",
 "version": "версия-платформы",
 "ibName": null,
 "paymentId": null,
 "errorString": null,
 "name": "Имя-информационной-базы",
 "published": 1,
 "resourceProtected": false,
 "publicationInterfaces": null,
 "limited": false,
 "hidden": false,
 "oldPath": null,
 "winAuth": false,
 "ibProtocol": "file"
 }

DELETE /api/webapps/ID-информационной-базы

Отключает выбранную публикацию информационной базы на встроенном веб-сервере по строке подключения, URL или хэшу адреса (алгоритм MD5).

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

DELETE http://localhost:<порт-веб-сервиса>/dashboard/product/com.company1c.link.agent.publisher.web/api/webapps/applicationId

Обязательные параметры запроса:

applicationId: ID-информационной-базы

Результат:

{
 "connectionString": " File=\"C:\\Users\\<имя-пользователя>\\Documents\\1C\\<Каталог-ИБ>\";",
 "md5": "ID-информационной-базы",
 "path": "путь-веб-приложения",
 "version": "версия-платформы",
 "ibName": null,
 "paymentId": null,
 "errorString": null,
 "name": "имя-информационной-базы",
 "published": 0,
 "resourceProtected": false,
 "publicationInterfaces": null,
 "limited": false,
 "hidden": false,
 "oldPath": null,
 "winAuth": false,
 "ibProtocol": "file"
}