RequestTrialUser

Request trial user license

Requests a trial user license for a specific product

GET https://signup.trialkey.ca/api/v2/LicReg

This endpoint requests for a new trial user to be created for the specified Domain and ProductCode. The AuthToken passed must be from the owner account for the specified domain. TrialKey will automatically confirm the newly requested users email by sending them an email with their new login credentials consisting of the UserName provided via the API as well as a randomly generated sequence for their password. The email sent allows them to click a link to confirm their account, as well as a link to change their password if they wish to. A corresponding license is created for the ProductCode that was passed in this API when the user confirms their email. Emails are branded with your logo if you have uploaded it to your account profile.

Example URL:

/RequestTrialUser?AuthToken=a75774e6-7a4a-44d0-8fc7-9f51c293ea7d&Domain=mydomain.com&ProductCode=<MY_PRODUCT_CODE>&UserName=[e-mail]

Query Parameters

Name	Type	Description
Domain*	String	Your account domain (i.e. the mywebsite.com part of www.mywebsite.com)
AuthToken*	String	The AuthToken acquired from calling the DoLogin() API.
ProductCode*	String	The ProductCode from your TrialKey dashboard that identifies the product a license is being registered for.
UserName*	String	The email and username of the new user to create. Note that this username must be a valid email address or the call will fail.

200 Call succeeded, user is authenticated and AuthToken returned

{
    "name"="Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "species": "Dog",}
    "breed": "Golden Retriever",
}

404: Not Found Call failed, parameters missing or invalid, or UserName trial is expired

Return Value: If the call succeeds then it will return an AuthToken identifier in the format a75774e6-7a4a-44d0-8fc7-9f51c293ea7d which can be used with other API calls. If the user not already exist, then it will be created. Once the users has confirmed their account via email, a trial license for the ProductCode will be created for the number of trial days that is specified in the Product as specified in the dashboard.

The call will fail with a 404 HTTP status code if any of the required parameters are missing or invalid. The call will also fail with a 404 if the UserName passed in already has a trial that has expired.