Applies to: Nerdio for Azure (NFA) Distributors
Nerdio API allows distributors to create, update, retrieve usage information and generally manage their partner accounts in Nerdio.
Which endpoints are typically used?
While there are several endpoints available, distributors will find themselves using the following API calls only:
- GET (loop and call /usage using the subscription ID(s) returned in /subscription)
What usage values are provided by the API?
/usage endpoint returns the following usage values:
current_usageis an average of desktop users count for the specified period (for NFA Professional and NFA Enterprise).
current_chargesis invoices total. We use date when invoice was generated, so if a user specifies period September 1, 2019 to September 30, 2019, user will see total from invoices generated on September 1, 2019.
projected_usageis a count of desktop users at the first day of specified period (for NFA Professional and NFA Enterprise).
How do I specify datetime values?
Some endpoints, such as
/usage, accept date time values. Format can be
yyyy-mm-dd. User can specify timezone by adding offset (+00:00), for example 09/08/2019 00:00:00-06:00. US/Central timezone (-06:00) is the default.
What is the latest version of API?
Current API version is v1.3. You must use v1.3 in all API calls. For example:
- Partners will create NFA accounts by logging in to NAP. Distributors should not create, update or delete Customers and Subscriptions via API.