Référence d’API pour le portail Cloud Partner

  • Article

Remarque

Les API de Portail Cloud Partner sont intégrées à Espace partenaires et continueront d’y fonctionner. La transition introduit de légères modifications. Passez en revue les modifications apportées aux API CPP listées dans ce document pour vous garantir que votre code continuera de fonctionner après la migration vers l’Espace partenaires. Les API du Portail Cloud Partner ne doivent être utilisées que pour les produits intégrés avant la transition vers l’Espace partenaires. Les nouveaux produits doivent employer les API de soumission à l’Espace partenaires.

Les API REST du portail Cloud Partner permettent de récupérer de manipuler par programmation des charges de travail, des offres et des profils d’éditeur. Les API utilisent le contrôle d’accès en fonction du rôle Azure (Azure RBAC) pour appliquer les autorisations appropriées au moment du traitement.

Cette référence contient les détails techniques des API REST du portail Cloud Partner. Les exemples de charge utile de ce document sont fournis à titre de référence uniquement et sont susceptibles de changer lors de l’ajout de nouvelles fonctionnalités.

Conditions préalables et considérations

Avant d’utiliser les API, consultez :

  • L’article Prérequis pour savoir comment ajouter un principal de service à votre compte et obtenir un jeton d’accès Microsoft Entra pour l’authentification.
  • Les deux stratégies de contrôle de la concurrence disponibles pour appeler ces API.
  • Autres considérations relatives à l’API, telles que le contrôle de version et la gestion des erreurs.

Modifications apportées aux API CPP après la migration vers l’Espace partenaires

API Description de la modification Impact
POST Publish, GoLive, Cancel Pour les offres migrées, l’en-tête de réponse a un format différent, mais continue de fonctionner de la même façon, en indiquant un chemin relatif pour récupérer l’état de l’opération. Lors de l’envoi d’une des demandes POST correspondantes pour une offre, l’en-tête Location a l’un des deux formats en fonction de l’état de migration de l’offre :
  • Offres non intégrées
    /api/operations/{PublisherId}${offerId}$2$preview?api-version=2017-10-31
  • Offres migrées
    /api/publishers/{PublisherId}/offers/{offereId}/operations/408a4835-0000-1000-0000-000000000000?api-version=2017-10-31
Opération GET Pour les types d’offres qui prenaient auparavant en charge le champ « notification-email » dans la réponse, ce champ est déprécié et n’est plus retourné pour les offres migrées. Pour les offres migrées, nous n’enverrons plus de notifications à la liste des e-mails spécifiés dans les requêtes. Au lieu de cela, le service d’API s’aligne sur le processus de messagerie de notification dans l’Espace partenaires pour envoyer des e-mails. Plus précisément, les notifications seront envoyées à l’adresse e-mail définie dans la section Coordonnées du vendeur de vos paramètres de compte dans l’Espace partenaires, pour vous informer de la progression de l’opération.

Passez en revue l’adresse e-mail définie dans la section Informations de contact du vendeur de vos paramètres de compte dans l’Espace partenaires pour vous assurer que l’e-mail correct est fourni pour les notifications.

Tâches courantes

Cette référence décrit en détail les API qui permettent d’effectuer les tâches courantes suivantes.

Offres

Opérations

Publier une application

Autres tâches

Dépannage

Versions et mises à jour de l’API

Mettre à jour Qu’est-ce qui a changé ?
12-2022 L’API publique CPP (version 2017-10-31) est désormais mise à jour pour capturer clientId et clientSecret pour le connecteur Marketo lors de la configuration des prospects clients. Pendant la configuration du prospect, vous n’avez pas besoin de fournir le champ serverId à l’avenir. Cette mise à jour vers l’API n’implique aucune mise à jour de version ni aucune modification cassant.