Поделиться через

Публикация веб-службы

  • Статья

Веб-службы представляют облегченный способ сделать доступными функции приложений для различных внешних систем и пользователей. По умолчанию Business Central предоставляет ряд объектов как веб-службы для лучшей интеграции с другими службами Microsoft. Вы можете добавить другие веб-службы, если этого требует ваш бизнес.

Настройте веб-службу в Business Central, а затем опубликуйте веб-службу, чтобы она была доступна пользователям, прошедшим аутентификацию. Все авторизованные пользователи могут получить доступ к метаданным для веб-служб, но доступ к фактическим данным имеется только у пользователей с достаточными разрешениями.

Создание и публикация веб-службы

В следующих шагах объясняется порядок создания и публикации веб-службы.

Создание и публикация веб-службы

  1. Выберите значок Лампочка, которая открывает функцию «Что вы хотите сделать»., введите Веб-службы, а затем выберите соответствующую ссылку.

  2. На странице Веб-службы выберите Создать. Наведите указатель на поле, чтобы увидеть короткое описание.

    Примечание

    Codeunit и Page являются допустимыми типами для веб-служб SOAP. Страница и Запрос являются допустимыми типами для веб-службы OData. Начиная с версии 16.3 Codeunit — это также допустимый тип для веб-служб OData v4, но тогда в пользовательском интерфейсе URL-адрес не отображается. Кроме того, если база данных содержит несколько организаций, можно выбрать Идентификатор объекта, относящийся к одной из организаций.
    Наконец, имя службы видимо для клиентов вашей веб-службы и является основой для идентификации и различения веб-служб, поэтому следует применять осмысленное имя.

  3. Установите флажок в столбце Опубликовано.

Когда вы публикуете веб-службу, поля URL-адрес OData и URL-адрес SOAP содержат новые URL-адреса. Однако для кодовых модулей, которые представлены как несвязанные действия OData v4, поля URL-адреса не отображаются.

Веб-службу можно немедленно проверить, выбрав ссылки в полях URL-адрес OData и URL SOAP. При необходимости скопируйте значение поля и сохраните его для последующего использования. Чтобы протестировать модули кода, которые представлены как несвязанные действия OData v4, следуйте инструкциям в разделе Проверка доступности веб-службы в материалах разработчика.

Примечание

Если объекты, которые вы предоставляете в качестве веб-служб, не должны быть доступны из Business Central Online, вы должны пометить предоставляемые в коде методы как [Scope('OnPrem')]. Дополнительные сведения см. в разделе Атрибут Scope.

После публикации веб-службы она становится доступна для внешних сторон. Можно проверить доступность веб-службы с помощью браузера или можно выбрать ссылку в полях URL-адрес OData и URL SOAP на странице Веб-службы. В следующей процедуре показано, как можно проверить наличие веб-службы для последующего использования.

Проверка наличия веб-службы

  1. В браузере введите соответствующий URL-адрес. В таблице ниже показаны типы URL-адресов, которые можно ввести для различных типов веб-служб.

    Тип Синтаксис Пример
    SOAP https://api.businesscentral.dynamics.com/*version*/*tenant*/Production/WS/*CompanyName*/*entity*/ https://api.businesscentral.dynamics.com/v2.0/7acc9d3d-d354-4616-8bbd-c4fc9f2b15b3/Production/WS/CRONUS%20USA%2C%20Inc./Page/InvoiceDocument
    OData V4 https://api.businesscentral.dynamics.com/*version*/*tenant*/Production/ODataV4/Company('*CompanyName*')/*entity* https://api.businesscentral.dynamics.com/v2.0/7acc9d3d-d354-4616-8bbd-c4fc9f2b15b3/Production/ODataV4/Company('CRONUS%20USA%2C%20Inc.')/InvoiceDocument
    Название организации учитывает регистр.

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

При доступе к веб-службе и необходимости внести данные в Business Central следует указать название организации. Можно указать организацию при URI, как показано в примерах, или же указать организацию при настройке параметров запроса. Например, следующие URI указывают на одну и ту же веб-службу OData, и оба URI действительны.

https://api.businesscentral.dynamics.com/v1.0/OData/Company('CRONUS International Ltd.')/Customer  

https://api.businesscentral.dynamics.com/v1.0/OData/Customer?company='CRONUS International Ltd.'

См. также

Администрация
Веб-сервисы Business Central для разработчиков
Ограничения запросов OData

Найдите бесплатные модули электронного обучения для Business Central здесь