Modèle d'objet de gestion de partenaire commercial : point de terminaison REST

Mis à jour: août 2015

Point de terminaison REST utilisé pour les API TPM OM.

Après que vous avez configuré votre BizTalk Service (procédure décrite dans http://go.microsoft.com/fwlink/p/?LinkId=299821), une URL de déploiement est créée pour votre environnement. Vous pouvez utiliser cette URL pour arriver au point de terminaison REST utilisé pour les API TPM OM.

Dans cette rubrique :

Découverte des entités TPM OM

API TPM OM : que faire à quel emplacement ?

Connexion au point de terminaison d'API REST TPM OM

Création d'applications .NET à l'aide de l'API TPM OM

Une API TPM OM utilise l'opération $metadata pour rendre les entités détectables. L'URI pour récupérer les métadonnées est :

<base_URL>/default/$PartnerManagement/$metadata

Ici, <base_URL> fait référence à l'URL de déploiement de l'environnement BizTalk Services. Par exemple, si l'URL de déploiement est https://mybiztalkservice.biztalk.windows.net, l'URL pour la récupération des métadonnées doit être https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/$metadata.

Cette URL vous permet de récupérer l'ensemble des types d'entités, propriétés d'entité, associations, fonctions, actions, etc. valides. Vous pouvez également afficher les métadonnées en appuyant sur le point de terminaison dans un navigateur.

L'API TPM OM permet aux utilisateurs d'écrire des applications destinées à créer et gérer les entités requises pour la messagerie interentreprises. Bien que la parité entre le modèle objet et les opérations disponibles via le portail soit censée être complète, il est nécessaire de réaliser certaines tâches en dehors de l'utilisation du modèle objet. Cette section fournit des informations sur les tâches pouvant être réalisées à l'aide du modèle objet, sur les tâches pouvant être réalisées avec les Applets de commande PowerShell pour gérer le service BizTalk, et sur les tâches pouvant être réalisées via le portail de services BizTalk.

 

  Utilisation du modèle objet Utilisation des applets de commande PowerShell Utilisation du Portail

Créer un partenaire

--- Créer un profil

--- Ajouter des identités

--- Télécharger un certificat

Créer un accord X12

--- Définir Partner1, Partner2

--- Ajouter des identités

--- Télécharger un schéma

--- Créer un lot

Déployer des ponts X12

--- Ajouter des paramètres de routage

--- Télécharger une transformation

Créer un accord AS2

--- Définir Partner1, Partner2

Déployer des ponts AS2

--- Ajouter des paramètres de routage

Créer un accord EDIFACT

--- Définir Partner1, Partner2

--- Ajouter des identités

--- Télécharger un schéma

--- Créer un lot

Déployer des ponts EDIFACT

--- Ajouter des paramètres de routage

--- Télécharger une transformation

Pour récupérer les métadonnées sur les entités TPM OM, vous pouvez simplement appuyer sur le point de terminaison dans un navigateur. Toutefois, si vous souhaitez effectuer des opérations CRUD sur les entités, vous devez demander des messages qui incluent les valeurs d'en-tête requises ainsi que la charge du message (si nécessaire).

  • Vous devez inclure les en-têtes requis pour invoquer le point de terminaison REST.

    L'API TPM OM permet aux utilisateurs d'envoyer des demandes HTTP OData pour créer des entités TPM OM et recevoir des réponses JSON détaillées, atom+pub ou XML seul. Étant donné que l'API TPM OM respecte les règles de conception de Azure, il existe un ensemble d'en-têtes HTTP obligatoires que chaque client doit utiliser lors de la connexion au point de terminaison REST de l'API TPM OM, ainsi qu'un ensemble d'en-têtes facultatifs utilisables. Les sections suivantes décrivent les en-têtes et les verbes HTTP que vous pouvez utiliser avec les API TPM OM.

    Pour obtenir la liste des en-têtes obligatoires et facultatifs, consultez les sections Requête HTTP, Réponse HTTP et Verbes HTTP (dans cette rubrique).

  • Autant que possible, vous devez inclure les noms de propriété requis avec les valeurs appropriées. Pour une liste des entités et de leurs propriétés, consultez API TPM OM : entités et propriétés exposées.

Chaque appel effectué aux points de terminaison REST de l'API TPM OM doit inclure un ensemble d'en-têtes obligatoires ainsi qu'un ensemble d'en-têtes facultatifs, le cas échéant. Le tableau suivant répertorie les en-têtes obligatoires :

En-têtes obligatoires

 

En-tête Type Valeur

Authorization

Jetons Access Control WRAP

La valeur doit inclure le jeton d'accès fourni par Microsoft Azure Active Directory Access Control (également appelé Access Control Service ou ACS). Pour récupérer un jeton Access Control à l'aide du protocole WRAP, consultez http://msdn.microsoft.com/library/windowsazure/hh674475.aspx.

Hôte

Chaîne

Spécifie l'hôte et le numéro de port de la ressource ciblée.

DataServiceVersion

Décimal

1.0

MaxDataServiceVersion

Décimal

3.0

x-ms-version

Décimal

1.0

If-Match

Balise d'entité

Indique qu'une opération est réalisée uniquement si la balise d'entité spécifiée dans l'en-tête de la demande correspond à la balise d'entité de l'objet.

noteRemarque
Cet en-tête est uniquement requis lors d'opérations de mise à jour ou de suppression.

noteRemarque
Étant donné que l'API TPM OM utilise OData pour exposer son référentiel de métadonnées de ressources sous-jacent via les API REST, les en-têtes DataServiceVersion et MaxDataServiceVersion doivent être inclus dans les demandes. Si ce n'est pas le cas, l'API TPM OM considère que la valeur DataServiceVersion à utiliser est 1.0.

En-têtes facultatifs

 

En-tête Type Valeur

Date

Date RFC 1123

Horodatage de la demande

Accept

Type de contenu

Type de contenu demandé pour la réponse, tel que :

  • application/xml

  • application/json;odata=verbose

  • application/atom+xml

Accept-Encoding

Gzip, deflate

Codage GZIP et DEFLATE, le cas échéant.

Accept-Language

« en », « es », etc.

Spécifie la langue préférée pour la réponse.

Accept-Charset

Type du jeu de caractères, comme UTF-8

La valeur par défaut est UTF-8

X-HTTP-Method

Méthode HTTP

Permet aux clients ou aux pare-feu qui ne prennent pas en charge les méthodes HTTP telles que PUT ou DELETE de les utiliser. Tunnel établi via un appel GET.

Content-Type

Type de contenu

Type de contenu du corps de la demande dans des demandes POST et PUT.

Les éléments suivants constituent un ensemble d'en-têtes pouvant être renvoyés en fonction de la ressource demandée et de l'action à entreprendre.

 

En-tête Type Valeur

Date

Date RFC 1123

Date de traitement de la demande

Content-Type

Variable

Type de contenu du corps de la réponse

Content-Encoding

Variable

Gzip ou deflate, comme approprié

Cache-Control

-

Spécifie si les mécanismes de mise en cache, du serveur au client, peuvent mettre l'objet en cache.

Content-Length

Type de contenu

Longueur du corps de la réponse

Serveur

-

Nom d'un serveur

X-Content-Type-Options

Type de contenu

La seule valeur possible, « nonsniff », empêche les navigateurs d'implémenter la détection MIME sur une réponse du type de contenu déclaré.

La liste suivante contient tous les verbes HTTP pris en charge par l'API TPM OM qui peuvent être utilisés dans des requêtes HTTP :

 

VERBE Description

GET

Renvoie la valeur actuelle d'une entité

POST

Crée un objet (ou envoie une commande) sur la base des données fournies

PUT

Remplace un objet ou en crée un (le cas échéant)

SUPPRIMER

Supprime un objet

MERGE

Met à jour un objet existant avec des modifications de propriété nommée

Comme l'API TPM OM repose sur le protocole OData, vous pouvez utiliser WCF Data Services pour créer des applications .NET qui effectuent des opérations CRUD sur les entités. Pour plus d'informations sur la création d'applications .NET à l'aide de l'API TPM OM, consultez Création d'applications .NET à l'aide de l'API REST TPM OM.

Voir aussi

Afficher: