Cloud Partner Portal API Reference

  • Article

Note

The Cloud Partner Portal APIs are integrated with and will continue working in Partner Center. The transition introduces small changes. Review the Changes to CPP APIs listed in this document to ensure your code continues working after transitioning to Partner Center. CPP APIs should only be used for existing products that were already integrated before transition to Partner Center; new products should use Partner Center submission APIs.

The Cloud Partner Portal REST APIs allow the programmatic retrieval and manipulation of workloads, offers, and publisher profiles. The APIs use Azure role-based access control (Azure RBAC) to enforce correct permissions at processing time.

This reference provides the technical details for the Cloud Partner Portal REST APIs. The payload samples in this document are for reference only and are subject to change as new functionality is added.

Prerequisites and considerations

Before using the APIs, you should review:

  • The Prerequisites article to learn how to add a service principal to your account, and get a Microsoft Entra access token for authentication.
  • The two concurrency control strategies available for calling these APIs.
  • Other API considerations, such as versioning and error handling.

Changes to CPP APIs after the migration to Partner Center

API Change description Impact
POST Publish, GoLive, Cancel For migrated offers, the response header has a different format but continues to work in the same way, denoting a relative path to retrieve the operation status. When sending any of the corresponding POST requests for an offer, the Location header has one of two format depending on the migration status of the offer:
  • Nonmigrated offers
    /api/operations/{PublisherId}${offerId}$2$preview?api-version=2017-10-31
  • Migrated offers
    /api/publishers/{PublisherId}/offers/{offereId}/operations/408a4835-0000-1000-0000-000000000000?api-version=2017-10-31
GET Operation For offer types that previously supported 'notification-email' field in the response, this field will be deprecated and no longer returned for migrated offers. For migrated offers, we'll no longer send notifications to the list of emails specified in the requests. Instead, the API service aligns with the notification email process in Partner Center to send emails. Specifically, notifications will be sent to the email address set in the Seller contact info section of your Account settings in Partner Center, to notify you of operation progress.

Review the email address set in the Seller contact info section of your Account settings in Partner Center to ensure the correct email is provided for notifications.

Common tasks

This reference details APIs to perform the following common tasks.

Offers

Operations

Publish an app

Other tasks

Troubleshooting

API versions and updates

Update  What has changed?
12-2022 CPP public API (version 2017-10-31) is now updated to capture clientId and clientSecret  for Marketo connector while configuring customer leads. During lead configuration you need not provide the serverId field going forward. This update to the API doesn't involve any version updates or breaking changes.