TrackerPro Admin API: Creating PAYT Clients & Users

The TrackerPro Admin API contains a Register endpoint to allow the creation of PAYT clients (and users). A PAYT client is a top level PAYT entity. All users and tracking data are stored against a client with PAYT.

Registering a PAYT Client

If not already created, this call creates a new client within the PAYT system. Also, if not already created, it creates a new user ssid for the user.

Make this call for each user that needs to be registered as a user for PAYT. If you call this twice for the same user, the user password will be updated and a new user sign on key (ssid) will be generated. Remember that PAYT users must have unique email addresses.

Example Request

https://trackerpro.payasyoutrack.com/trackerpro_admin.ashx?key=XXXXADMINKEYXXXX&op=Admin&subop=Register&company=testertester21&[email protected]&password=whateverthepasswordis

Request (Query Parameters)

Parameter	Value	Notes
key	{XXXXADMINKEYXXXX}	Required – TrackerPro admin api key
op	Admin	Required
subop	Register	Required
company	{string}	Required – should be set to the trackerpro (subdomain). For example, for allsecure.trackerpro.co.uk set to ‘allsecure’
email	{valid email}	Required – email addresses within PAYT are unique. This acts as the payt user name
password		Required – can be auto generated. This is not required by the user as PAYT can be launched via the ‘Launch’ call.

Example Success Response

{"version":"0.6","reqId":"0","status":"ok","sig":"","value":"488A6802-AD46-4BB4-B2E3-653C3ACF9F14"}

The returned ‘value’ is the ssid for the user. This should be stored against a user within the TrackerPro system.

Example Fail Response

{"version":"0.6","status":"error","errors":[{"reason":"invalid_query","message":"User name should be unique to client"}]}

Back to: Contents

---