Modelo de objetos de administración de socios comerciales: Extremo REST

Actualizado: agosto de 2015

Extremo REST usado para las API OM TPM.

Después de haber aprovisionado su servicio de BizTalk (puede encontrar los pasos en http://go.microsoft.com/fwlink/p/?LinkId=299821), una URL de implementación se crea para su entorno. Puede usar esa dirección URL para llegar al extremo REST que se usa para las API OM TPM.

En este tema:

Descubrimiento de las entidades OM TPM

API OM TPM: ¿Qué hacer y dónde?

Conexión al extremo REST de la API OM TPM

Creación de aplicaciones .NET con la API OM TPM

API OM TPM usa la operación $metadata para detectar las entidades. El URI para recuperar los metadatos es:

<base_URL>/default/$PartnerManagement/$metadata

En este caso, <base_URL> hace referencia a la dirección URL de implementación del entorno Servicios de BizTalk. Por ejemplo, si la dirección URL de implementación es https://mybiztalkservice.biztalk.windows.net, la dirección URL para recuperar los metadatos debe ser https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/$metadata.

Esta URL le permite recuperar todos los tipos de entidad válidos, las propiedades de las entidades, las asociaciones, etc. También puede ver los metadatos cuando se alcanza el extremo en un explorador.

La API OM TPM permite a los usuarios escribir aplicaciones para crear y administrar las entidades necesarias en mensajería negocio a negocio. Aunque el modelo de objetos tiene como fin lograr la paridad total con las operaciones disponibles a través del portal, hay alguna tareas que aún se realizan fuera del ámbito de uso del modelo de objetos. En esta sección se proporciona información sobre las tareas que pueden realizarse usando el modelo de objetos, las tareas que pueden realizarse usando CmdLets de PowerShell para administrar el servicio BizTalk y las tareas que pueden realizarse usando el Portal de servicios de BizTalk.

 

  Uso del modelo de objetos Uso de los cmdlets de PowerShell Uso del portal

Crear asociado

--- Crear perfil

--- Agregar identidades

--- Cargar certificado

Crear acuerdo X12

--- Establecer asociado1, asociado2

--- Agregar identidades

--- Cargar esquema

--- Crear lote

Implementar puentes de X12

--- Agregar configuración de rutas

--- Cargar transformación

Crear acuerdo AS2

--- Establecer asociado1, asociado2

Implementar puentes de AS2

--- Agregar configuración de rutas

Crear acuerdo EDIFACT

--- Establecer asociado1, asociado2

--- Agregar identidades

--- Cargar esquema

--- Crear lote

Implementar puente de EDIFACT

--- Agregar configuración de rutas

--- Cargar transformación

Para recuperar los metadatos sobre las entidades OM TPM, simplemente tiene que presionar el extremo en un explorador. Sin embargo, si desea realizar cualquier operación CRUD en las entidades, debe solicitar mensajes que incluyan los valores de encabezado necesarios, así como la carga del mensaje (si es necesario).

  • Debe incluir los encabezados necesarios para invocar el extremo REST.

    La API OM TPM permite a los usuarios enviar solicitudes HTTP basadas en OData para crear entidades TPM OM y recibir respuestas en JSON detallado, atom+pub o XML directo. Debido a que la API OM TPM cumple con las directrices de diseño de Azure, existe un conjunto de encabezados HTTP obligatorios que cada cliente debe utilizar al conectarse al extremo REST de la API OM TPM, así como un conjunto de encabezados opcionales que se pueden usar. En las secciones siguientes se describen los encabezados y verbos HTTP que puede utilizar con la API OM TPM.

    Para obtener una lista de los encabezados necesarios y opcionales, vea las secciones de Solicitud HTTP, Respuesta HTTP y Verbos HTTP (en este tema).

  • Siempre que sea aplicable, debe incluir los nombres de propiedad necesarios con los valores adecuados. Para obtener una lista de entidades y sus propiedades, vea API OM TPM: entidades y propiedades expuestas.

Todas las llamadas efectuadas a los extremos REST de la API OM TPM deben incluir un conjunto de encabezados necesarios y también un conjunto de encabezados opcionales, si lo desea. En la siguiente tabla se enumeran los encabezados obligatorios.

Encabezados obligatorios

 

Encabezado Tipo Valor

Autorización

Tokens de Control de acceso WRAP

El valor debe incluir el token de acceso proporcionado por el Active Directory Access Control de Microsoft Azure (también conocido como Access Control Service o ACS). Para obtener token de Control de acceso mediante el protocolo WRAP, consulte http://msdn.microsoft.com/library/windowsazure/hh674475.aspx.

Host

Cadena

Especifica el host y el número de puerto del recurso de destino.

DataServiceVersion

Decimal

1.0

MaxDataServiceVersion

Decimal

3.0

x-ms-version

Decimal

1.0

If-Match

Etiqueta de entidad

Especifica que una operación solamente se lleva a cabo si la etiqueta de entidad especificada en el encabezado de la solicitud coincide con la etiqueta de entidad del objeto.

noteNota
Este encabezado solamente se requiere al llevar a cabo operaciones de actualización o eliminación.

noteNota
Dado que la API OM TPM utiliza OData para exponer su repositorio de metadatos de recursos subyacente a través de las API de REST, los encabezados DataServiceVersion y MaxDataServiceVersion deben incluirse en las solicitudes. Si no se incluyen, actualmente la API TPM OM supone que el valor de DataServiceVersion utilizado es 1.0.

Encabezados opcionales

 

Encabezado Tipo Valor

Fecha

Fecha de RFC 1123

Marca de tiempo de la solicitud

Accept

Tipo de contenido

Tipo de contenido solicitado para la respuesta, como el siguiente:

  • aplicación/xml

  • aplicación/json;odata=verbose

  • aplicación/atom+xml

Accept-Encoding

Gzip, deflate

Codificación GZIP y DEFLATE, cuando sea aplicable.

Accept-Language

"en", "es", etc.

Especifica el idioma preferido de la respuesta.

Accept-Charset

Tipo de conjunto de caracteres, por ejemplo, UTF-8

El valor predeterminado es UTF8.

X-HTTP-Method

Método HTTP

Permite a los clientes o firewalls que no admiten métodos HTTP como PUT o DELETE utilizar estos métodos, enviados por túnel a través de una llamada GET.

Content-Type

Tipo de contenido

Tipo de contenido del cuerpo de la solicitud en solicitudes POST y PUT.

A continuación se facilita un conjunto de encabezados que es posible que se te envíen en función del recurso que estaba solicitando y de la acción que pretendía llevar a cabo.

 

Encabezado Tipo Valor

Fecha

Fecha de RFC 1123

Fecha en la que se procesó la solicitud.

Content-Type

Varía

El tipo de contenido del cuerpo de la respuesta.

Content-Encoding

Varía

Gzip o deflate, según corresponda

Cache-Control

-

Especifica si los mecanismos de almacenamiento en memoria caché, de servidor a cliente, pueden almacenar el objeto en la memoria caché.

Content-Length

Tipo de contenido

Longitud del cuerpo de la respuesta

Servidor de

-

Nombre del servidor.

X-Content-Type-Options

Tipo de contenido

El único valor posible (“nonsniff”) evita que los exploradores realicen el examen de MIME de una respuesta desde el tipo de contenido declarado.

A continuación se facilita una lista completa de los verbos HTTP admitidos por la API OM TPM y que pueden utilizarse al efectuar solicitudes HTTP:

 

VERBO Descripción

GET

Devuelve el valor actual de una entidad

POST

Crea un objeto (o envía un comando) basado en los datos proporcionados

PUT

Sustituye un objeto o crea un objeto nuevo (cuando resulta aplicable)

DELETE

Elimina un objeto.

MERGE

Actualiza un objeto existente con cambios de propiedades con nombre.

Dado que la API OM TPM se basa en el protocolo OData, puede usar WCF Data Services para crear aplicaciones .NET que realizan operaciones CRUD en las entidades. Para obtener más información sobre cómo crear aplicaciones .NET mediante la API OM TPM, vea Creación de aplicaciones .NET mediante la API de REST OM TPM.

Vea también

Mostrar: