DoLogin

Login and verify credentials

Verifies credentials

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

Example URL:

/DoLogin?User=[e-mail]&Pass=userpass&Domain=mywebsite.com

This endpoint allows a trial or licensed user to verify their credentials for your application(s). Once logged in the LicCheck API call can be used to check information on their license.

Query Parameters

Name	Type	Description
User*	String	The user's username
Pass*	String	The user's password
Domain*	String	Your account domain (i.e. the mywebsite.com part of www.mywebsite.com)
AccountAPIToken*	String	Your account API token from the profile screen in the TrialKey API dashboard. This key should be kept secret since it allows you, in combination with your user name and password, to perform actions on your users such as deleting or modify them or their products and licenses.
InstallKey	String	This optional parameter allow an InstallKey to be passed for validation to the LicCheck() function if the login portion of the call succeeds. If the string default is passed instead of passing a valid InstallKey, then the system will find and validate against the first available license for this user, and the resulting possible responses will correspond to that call. This essentially allows an application that only needs each user to have a single license to use the authentication only to validate and maintain a licensed application with a single API call, without having to store anything.

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 User not authenticated or error

Return Value: If the user is successfully authenticated, then the call returns a string that represents an authentication token (referred to as an AuthToken) in the format a75774e6-7a4a-44d0-8fc7-9f51c293ea7d. This token can be subsequently used in other calls to check the license etc. This AuthToken is also set as a cookie called AuthToken and is also returned as a custom header called AuthToken.