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

Notes

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 de Portail Cloud Partner doivent uniquement être utilisées pour les produits existants intégrés avant la transition vers Espace partenaires. Les nouveaux produits doivent utiliser les API de soumission d’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.

Prérequis 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 Azure Active Directory (Azure AD) pour l’authentification.
  • Les deux stratégies de contrôle de la concurrence disponibles pour appeler ces API.
  • Les autres considérations relatives aux API, comme 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 aura un format différent, mais continuera à fonctionner de la même façon, indiquant un chemin relatif pour récupérer l’état de l’opération. Lors de l’envoi d’une des requêtes de publication correspondantes pour une offre, l’en-tête d’emplacement aura l’un des deux formats suivants en fonction de l’état de migration de l’offre :
  • Offres non migré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’alignera sur le processus de notification par e-mail 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.

Veuillez vousérifiez l’adresse e-mail définie dans la section Coordonnées du vendeur de vos Paramètres du compte dans l’Espace partenaires afin de vous assurer que l’adresse e-mail correcte est fournie 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