Элемент проекта вида «SoapСервис»

Для создания SOAP-сервиса следует добавить в проект элемент SOAP-сервис.

В описании элемента проекта указываются настройки создаваемого сервиса, его свойства и методы, которые реализуют операции SOAP-сервиса. Модуль SOAP-сервиса содержит описание передаваемых данных (структур встроенного языка), пользовательских исключений, а также реализацию операций сервиса.

Описание элемента проекта «SoapСервис»

При создании описания SOAP-сервиса вам необходимо определить следующие свойства:

ПространствоИменСервиса — пространство имен, в котором описан сервис. Атрибут targetNamespace WSDL-описания сервиса (definitions.targetNamespace).
ИмяСервиса — имя сервиса. Атрибут name WSDL-описания сервиса (definitions.name). Если не указан, то используется имя элемента проекта.
КорневойUrl — базовая часть URL, по которой будет выполняться обращение к сервису.
Обработчики — описание операций, которые выполняют обработку данных из входящего SOAP-сообщения от клиента сервиса и формируют результат для исходящего SOAP-сообщения. Для каждой операции вы должны создать метод, который реализует необходимую функциональность. Методы находятся в модуле SOAP-сервиса.

Например, SOAP-сервис может выглядеть следующим образом:

ВидЭлемента: SoapСервис
Ид: 20658364-7777-4b14-9423-ec212de5be72
Имя: СервисМагазина
ОбластьВидимости: ВПодсистеме
КонтрольДоступа:
    Разрешения:
        Вызов: РазрешеноВсем
        ПоУмолчанию: РазрешеноВсем
ПространствоИменСервиса: https://mycustomshop.ru
ИмяСервиса: ShopService
КорневойUrl: shopservice
Обработчики:
    -
        Имя: AddToCart
        Метод: ДобавитьВКорзину
        Ошибки:
            - СервисМагазина.MyCustomException

Модуль SOAP-сервиса

В модуле SOAP-сервиса следует добавить:

Структуры, которые описывают передаваемые в сервис параметры и результат запроса. Вместо структур можно также использовать встроенные типы — Число, Строка и т. д. Данные типы будут автоматически сопоставлены с соответствующими XML-типами.
Используемые в сервисе исключения. Данные типы будут сопоставлены с SOAP-ошибками.
Методы для описания операций, выполняемых в результате вызова обработчиков.

Пример модуля SOAP-сервиса:

// Описание пользовательской ошибки
@ВПроекте
исключение MyCustomException
  обз пер Description: Строка
  обз пер ErrorCode: Число
;

// Структура, описывающая параметры обработчика
структура Item
    обз пер Id: Число
    обз пер Name: Строка
    обз пер Price: Число
;

// Обработчик операции сервиса
метод ДобавитьВКорзину(Товар: Item, Количество: Число)
    // Метод, написанный разработчиком
;

Ограничения на код модуля

Запрещено использовать кириллицу в именах обработчиков.

В структурах встроенного языка, используемых в сообщениях (параметрах и возвращаемых значениях обработчиков SOAP-сервиса), в заголовках, а также исключениях встроенного языка, используемых как SOAP-ошибки:

Не должно быть циклических ссылок.
Допустим только составной тип, состоящий из одного из поддерживаемых типов + Неопределено. В этом случае в XML-элементе будет использовано ограничение minOccurs=0. Другие составные типы не разрешены.
Допустимы только следующие типы данных:

Тип встроенного языка	XML тип	Примечание
`Строка`	`string`
`Число`	`decimal`
`Булево`	`boolean`
`ДатаВремя`	`dateTime`
`Дата`	`date`
`Время`	`time`
`Месяц`	`gMonth`
`Длительность`	`duration`
`Байты`	`base64Binary`
`Структура`		`complexType`
`Неопределено`		`minOccurs=0`
`ЧитаемаяКоллекция<Тип>`, где `Тип` — значения поддерживаемого типа		`minOccurs=unbounded`; не поддерживается коллекция коллекций

Также в модуле SOAP-сервиса можно обработать событие ВычислитьРазрешенияДоступа (подробнее).

WSDL-описание SOAP-сервиса

«1С:Шина» из элемента проекта формирует WSDL-описание SOAP-сервиса. Чтобы получить описание, следует выполнить GET-запрос к сервису с параметром ?wsdl. Пример:

<definitions xmlns="http://schemas.xmlsoap.org/wsdl/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:tns="https://mycustomshop.ru" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" targetNamespace="https://mycustomshop.ru">
    <types>
        <xsd:schema>
            <xsd:import namespace="https://mycustomshop.ru" schemaLocation="http://127.0.0.1:9090/applications/soap-service-app/api/shopservice?xsd=1"/>
        </xsd:schema>
    </types>
    <message name="AddToCart">
        <part name="parameters" element="tns:AddToCart"/>
    </message>
    <message name="AddToCartResponse">
        <part name="parameters" element="tns:AddToCartResponse"/>
    </message>
    <message name="MyCustomException">
        <part name="fault" element="tns:MyCustomException"/>
    </message>
    <portType name="ShopService">
        <operation name="AddToCart">
            <input message="tns:AddToCart"/>
            <output message="tns:AddToCartResponse"/>
            <fault message="tns:MyCustomException" name="MyCustomException"/>
        </operation>
    </portType>
    <binding name="ShopServicePortBinding" type="tns:ShopService">
        <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
        <operation name="AddToCart">
            <soap:operation soapAction="AddToCart"/>
            <input>
                <soap:body use="literal"/>
            </input>
            <output>
                <soap:body use="literal"/>
            </output>
            <fault name="MyCustomException">
                <soap:fault name="MyCustomException" use="literal"/>
            </fault>
        </operation>
    </binding>
    <service name="ShopService">
        <port name="ShopServicePort" binding="tns:ShopServicePortBinding">
            <soap:address location="http://127.0.0.1:9090/applications/soap-service-app/api/shopservice"/>
        </port>
    </service>
</definitions>

URL для запроса к SOAP-сервису

Сервис обрабатывает POST-запросы. Корректный URL запроса к SOAP-сервису должен иметь следующую структуру:

{АдресПубликацииПриложения}/api/{КорневойURL}

Для данного элемента проекта приложение будет обрабатывать SOAP-запросы к сервису по пути:

http://[адрес сервера]/applications/[имя приложения]/api/shopservice

Чтобы получить WSDL-описание сервиса, следует отправить GET-запрос с параметром ?wsdl. Например:

http://[адрес сервера]/applications/[имя приложения]/api/shopservice?wsdl

Рассмотрим части запроса по порядку:

http или https: http://

Используемый протокол.
АдресПубликацииПриложения: [адрес сервера]/applications/[имя приложения]/

Адрес «1С:Шины» и путь публикации приложения на сервере.
api: api/

Признак того, что данный URL представляет запрос к публичному API приложения.
КорневойURL: shopservice

Относительный URL сервиса. Должен быть уникальным среди всех сервисов в проекте. Определяет конкретный сервис, который должен обработать запрос.
ПараметрыЗапроса: ?wsdl

Стандартный способ передачи параметров запроса через URL.

Права

Элемент проекта вида SoapСервис обладает правом Вызов (подробнее).

Событие ВычислитьРазрешенияДоступа следует обрабатывать в модуле SOAP-сервиса.

См. также

Свойства SOAP-сервиса

Описание элемента проекта «SoapСервис»​

Модуль SOAP-сервиса​

Ограничения на код модуля​

WSDL-описание SOAP-сервиса​

URL для запроса к SOAP-сервису​

Права​

См. также​