Common Usecases: Account Provisioning

Account and License provisioning

Overview

This document is intended for third parties that want to integrate their application environment with the Nomadesk platform using the Nomadesk API.

The most basic and common usecases are account provisioning.
This document will get you started.

More information of every API call listed below, can be found in the general API Documentation.

Create the account for the user:

NMRA and BRAND are provided to you when you sign up as a Nomadesk partner.

https://secure.nomadesk.com/ctrller/api.php?Task=CreateAccount&Email=newaccount@test.com&FirstName=firstname&LastName=lastname&GoogleAnalyticsSource=NMRA&Brand=BRAND

Get some information needed for the calls in step 3

AMSUSERNAME and PASSWORD are provided to you when you sign up as a Nomadeks partner.

AMSTOKEN (partner security token) = 
https://secure.nomadesk.com/ctrller/api.php?Task=Logon&AMSUsername=AMSUSERNAME&AMSPassword=PASSWORD

NMUA (internal name of the newly created user)= 
https://secure.nomadesk.com/ctrller/api.php?Token=AMSTOKEN&Task=GetAccountInfo&Email=newaccount@test.com

Assign a license to this user(if you don’t, he will be ‘in trial’ for 14 days):

https://secure.nomadesk.com/ctrller/api.php?Subscription[0][newcount]=1&Subscription[0][Type]=Monthly&Subscription[0][Emails][]=newaccount@test.com&Token=AMSTOKEN&Task=AssignLicenses&AccountName=NMUA&SkipConfirm=true

Buy 10 more (unassigned) licenses for this account (he will be able to assign from our web interface mynomadesk.com):

https://secure.nomadesk.com/ctrller/api.php?Subscription[0][newcount]=10&Subscription[0][Type]=Monthly&Token=AMSTOKEN&Task=AssignLicenses&AccountName=NMUA&SkipConfirm=true

Buy 2 more licenses for this account, and assign them to the accounts passed here:

https://secure.nomadesk.com/ctrller/api.php?Subscription[0][newcount]=2&Subscription[0][Type]=Monthly&Token=AMSTOKEN&Task=AssignLicenses&AccountName=NMUA&SkipConfirm=true&Subscription[0][Emails][]=licenseduser1@test.com&Subscription[0][Emails][]=licenseduser2@test.com

Get an overview of the licenses this user has:

LICENSEID = 
https://secure.nomadesk.com/ctrller/api.php?Task=GetLicenses&Token=AMSTOKEN&AccountName=NMUA

Remove an (unassigned) license:

https://secure.nomadesk.com/ctrller/api.php?Task=RemoveLicense&Token=AMSTOKEN&ID=LICENSEID