Модель объектов управления торговыми партнерами: конечная точка REST

Обновлено: Август 2015 г.

Конечная точка REST, используемая для API OM TPM.

После подготовки службы BizTalk (шаги на http://go.microsoft.com/fwlink/p/?LinkId=299821) создается URL-адрес развертывания для вашей среды. Этот URL-адрес можно использовать для доступа к конечной точке REST, используемой для TPM OM API.

В этом разделе:

Обнаружение сущностей TPM OM

TPM OM API: Что делать?

Подключение к конечной точке REST TPM OM API

Создание приложений .NET с помощью TPM OM API

TPM OM API использует операцию $metadata, чтобы сделать возможным обнаружение сущностей. URI для получения метаданных имеет следующий вид:

<base_URL>/default/$PartnerManagement/$metadata

Здесь <base_URL> относится к URL-адресу развертывания среды Службы BizTalk. Например, если URL-адрес развертывания — https://mybiztalkservice.biztalk.windows.net, то URL-адрес для получения метаданных должен быть https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/$metadata.

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

API OM TPM предоставляет пользователям возможность разработки приложений для создания и обслуживания сущностей, необходимых при обмене сообщениями B2B. Хотя объектная модель стремится иметь полный паритет с операциями, доступными через портал, есть некоторые задачи, которые по-прежнему выполняются за рамками использования объектной модели. В этой статье предоставляются сведения о задачах, которые могут выполняться с использованием объектной модели, задачах, которые могут выполняться с помощью Командлеты PowerShell — службы BizTalk Azure, и задачах, которые могут выполняться с помощью Портал служб BizTalk.

 

  Использование объектной модели Использование командлетов PowerShell Использование портала

Создать партнера

--- Создать профиль

--- Добавить удостоверения

--- Отправить сертификат

Создать соглашение X12

--- Установить Partner1, Partner2

--- Добавить удостоверения

--- Отправить схему

--- Создать пакет

Развертывание мост X12

--- Добавить параметры маршрутизации

--- Отправить преобразование

Создать соглашение AS2

--- Установить Partner1, Partner2

Развертывание мост AS2

--- Добавить параметры маршрутизации

Создание соглашения EDIFACT

--- Установить Partner1, Partner2

--- Добавить удостоверения

--- Отправить схему

--- Создать пакет

Развертывание мост EDIFACT

--- Добавить параметры маршрутизации

--- Отправить преобразование

Чтобы получить метаданные о сущностях TPM OM, можно просто нажать конечную точку в браузере. Но если требуется выполнять любые операции CRUD для сущностей, необходимо запросить сообщения, содержащие значения требуемых заголовков, а также полезные данные сообщения (при необходимости).

  • Необходимо включить требуемые заголовки для вызова конечной точки REST.

    API OM TPM предоставляет пользователям возможность отправлять HTTP-запросы на создание сущностей OM TPM на основе протокола OData и получать ответы в подробном формате JSON, atom+pub или прямом XML. Поскольку API OM TPM соответствует правилам проектирования Azure, существует ряд обязательных заголовков HTTP, которые должен использовать каждый клиент при подключении к конечной точке API REST OM TPM, а также ряд дополнительных заголовков, которые могут использоваться. В следующих разделах описываются заголовки и HTTP-команды, которые можно использовать в API OM TPM.

    Список обязательных и необязательных заголовков см. в подразделах HTTP-запросы, HTTP-ответы и HTTP-команды (в этом разделе).

  • Везде, где это применимо, необходимо включать требуемые имена свойств с соответствующими значениями. Список сущностей и их свойств можно найти в разделе TPM OM API: предоставляемые сущности и свойства.

Каждый вызов в конечные точки REST API OM TPM должен включать ряд обязательных заголовков, а также по желанию ряд дополнительных заголовков. В следующей таблице описываются обязательные заголовки.

Обязательные заголовки

 

Заголовок Тип Значение

Авторизация

Токены WRAP Управление доступом

Значение должно включать токен доступа, предоставленный Microsoft Azure Active Directory Access Control (также называется Access Control Service или ACS). Инструкции по извлечению токена Управление доступом с помощью протокола WRAP см. по адресу: http://msdn.microsoft.com/library/windowsazure/hh674475.aspx.

Host

Строка

Задает узел и номер порта целевого ресурса.

DataServiceVersion

Десятичное число

1.0

MaxDataServiceVersion

Десятичное число

3.0

x-ms-version

Десятичное число

1.0

If-Match

Тег сущности

Указывает, что операция выполняется только в том случае, если тег сущности, заданный в заголовке запроса, соответствует тегу сущности объекта.

noteПримечание
Этот заголовок требуется только при выполнении операций обновления или удаления.

noteПримечание
Поскольку API OM TPM использует протокол OData для предоставления своего базового репозитория метаданных ресурсов через API REST, заголовки DataServiceVersion и MaxDataServiceVersion необходимо включать в любой запрос. Если же они не включены, то в настоящее время API OM TPM предполагает, что значение DataServiceVersion равно 1.0.

Дополнительные заголовки

 

Заголовок Тип Значение

Дата

Дата RFC 1123

Метка времени запроса.

Accept

Тип содержимого

Запрошенный тип содержимого для ответа, например следующий:

  • application/xml

  • application/json;odata=verbose

  • application/atom+xml

Accept-Encoding

Gzip, deflate

Шифрование GZIP и DEFLATE, где это применимо.

Accept-Language

en, es и т. п.

Задает предпочтительный язык ответа.

Accept-Charset

Тип набора символов, например UTF-8

Значение по умолчанию — UTF-8.

X-HTTP-Method

Метод HTTP

Позволяет клиентам или брандмауэрам, не поддерживающим такие методы HTTP, как PUT или DELETE, использовать эти методы, туннелированные посредством вызова GET.

Content-Type

Тип содержимого

Тип содержимого текста запроса в запросах POST и PUT.

Далее приводятся заголовки, которые могут быть вам возвращены в зависимости от запрошенного ресурса и действия, которое вы собирались выполнить.

 

Заголовок Тип Значение

Дата

Дата RFC 1123

Дата обработки запроса

Content-Type

Разный

Тип содержимого текста ответа.

Content-Encoding

Разный

Gzip или deflate, по обстоятельствам

Cache-Control

-

Указывает, могут ли механизмы кэширования, от сервера до клиента, кэшировать объект.

Content-Length

Тип содержимого

Длина текста ответа.

сервер;

-

Имя сервера.

X-Content-Type-Options

Тип содержимого

Единственное возможное значение nonsniff запрещает браузерам выполнять сканирование MIME ответа из объявленного типа содержимого.

Далее приводится полный список HTTP-команд, которые поддерживаются API OM TPM и могут использоваться при выполнении HTTP-запросов.

 

КОМАНДА Описание

GET

Возвращает текущее значение для сущности.

POST

Создает объект (или выдает команду) на основе предоставленных данных.

PUT

Заменяет объект или создает новый объект (где это применимо).

DELETE

Удаляет объект.

MERGE

Обновляет объект с использованием изменений указанного свойства.

TPM OM API основан на протоколе OData, поэтому вы можете использовать службы данных WCF для создания приложений .NET, которые выполняют операции CRUD над сущностями. Подробнее о создании приложений .NET с помощью TPM OM API см. в разделе Создание приложений .NET с использованием API TPM OM REST.

См. также

Показ: