Zdieľať cez

SaaS fulfillment APIs in the Microsoft commercial marketplace

  • Článok

The SaaS Fulfillment APIs enable publishers, also known as independent software vendors (ISVs), to publish and sell their SaaS applications in Microsoft AppSource, Azure Marketplace, and Azure portal. These APIs enable ISV applications to participate in all commerce enabled channels: direct, partner-led (reseller), and field-led. Integrating with these APIs is a requirement for creating and publishing a transactable SaaS offer in Partner Center.

To learn about the SaaS fulfillment APIs, we recommend you also read the following articles:

API flows

ISVs must implement the following API flows by adding into their SaaS service code to maintain the same subscription status for both ISVs and Microsoft:

  • Landing page flow: Microsoft notifies the publisher that the publisher's SaaS offer was purchased by a customer in the marketplace.
  • Activation flow: Publisher notifies Microsoft that a newly purchased SaaS account was configured on the publisher's side.
  • Update flow: Change of purchased plan or the number of purchased seats or both.
  • Suspend and reinstate flow: Suspending the purchased SaaS offer in case the customer's payment method is no longer valid. The suspended offer can be reinstated when the issue with payment method is resolved.
  • Webhook flows: Microsoft notifies the publisher about SaaS subscription changes and cancellation triggered by the customer from the Microsoft side.

For the cancellation of the purchased SaaS subscription, integration is optional, because it can be done by the customer from Microsoft side.

Correct integration with SaaS Fulfillment APIs is critical for making sure that:

  • End customers who purchased the publisher's SaaS offer are billed correctly by Microsoft.
  • End customers are getting the correct user experience purchasing, configuring, using, and managing SaaS subscriptions purchased in the marketplace.

These APIs enable the publisher's offers to participate in all commerce enabled channels:

  • Direct
  • Partner-led (reseller, Cloud Solution Provider [CSP])
  • Field-led

In the reseller (CSP) scenario, a CSP is purchasing the SaaS offer on behalf of the end customer. A customer is expected to use the SaaS offer, but the CSP is the entity that does the following tasks:

  • Bills the customer
  • Changes subscription plans/amount of purchased seats
  • Cancels the subscriptions

The Publisher isn't required to implement any of the API call flows differently for this scenario.

For more information, see Cloud Solution Provider (CSP).

Warning

SaaS Fulfillment APIs version 1 was deprecated; instead, use V2. V1 is currently being maintained only to serve existing publishers, and documentation for V1 is no longer available. If you feel that you need to access it, you can email saas-api-v1@microsoft.com.

Note

The SaaS fulfillment APIs are only intended to be called from a backend service of the publisher. Integration with the APIs directly from the publisher's web page isn't supported. Only service-to-service authentication flow should be used.

Related content

Video tutorials