Nerdio Manager Distributor API - Examples

This article lists examples of some common API calls and responses.

/register

Claim a MSP partner's existing and future Nerdio Manager installs in their Azure subscription. This API is typically used when a partner purchases Nerdio Manager in your portal.

Example #1

A positive use case. The typical flow when you have fed all the right values to the API call and get a 200 response since the API call was successful.

Example #2

A positive use case. The typical flow when you have fed all the right values to the API call and get a 200 response since the API call was successful. This example shows the response when a partner has multiple installs of Nerdio Manager in the same Azure subscription. While this is a rare use case, program your end to absorb multiple InstallIDs.

Example #3

A negative use case. The API response when Nerdio Manager installs are already claimed by another distributor.

Example #4

A negative use case. The API response when the APIKey is incorrect.

/invoices

Collect invoice information. This API is typically used for monthly billing.

Example #1

A positive use case. The typical flow when you have fed all the right values to the API call and get a 200 response since the API call was successful.

You can view and download the JSON file for the entire response.

A few things to note about the /usage API and response:

• The period start and end dates must be in the mm/dd/yyyy format.

• The response matches the invoice you see in the Mothership portal.

• The Type column in the invoice indicates if line item is a chargeable item or a discount.

• The possible values for Type are:

  • AVD Users: The number of end users that are assigned an AVD desktop, averaged out over the calendar month.

  • Cloud PC-only Users: The number of end users that are assigned a Windows 365 Cloud PC but not a AVD desktop, averaged out over the calendar month.

  • Discount: A reduction in cost applied to an account or partner (install) or distributor.

  • Price Control: A floor or ceiling applied to an account, partner, or distributor. For example, Nerdio may have an arrangement with a partner to charge a minimum of $1,000 per month. That would be a floor price control. Similarly, Nerdio may have an arrangement to charge a maximum of $50,000 per month with a different partner. That would be a ceiling price control.

  • Upcharge: Generally these are charges for services besides AVD and Cloud PC licenses. They are applied to the invoice overall (not at the individual account or install level). These entries are rare and listed here only to make you aware.

Example #2

A negative use case. The API response when usage information is not available for the specified period.

Example #3

A negative use case. The API response when the date range is incorrect.

/reactivate

Unsuspend all installs in an Azure subscription. This API is typically used to remove the temporary halt for non-payment.

Example #1

A positive use case. The typical flow when you have fed all the right values to the API call and get a 200 response since the API call was successful.

Example #2

A negative use case. This showcases the API response when you provide an incorrect value for a parameter.