API Service Documentation

Command: user_login_link

Returns a login link. Also automatically creates the specified user if provided external_id isn't found in the system.
Commandline Example: curl --data "ai_login_id=api_user&ai_login_password=IhN4hth1IwlL&ai_command=user_login_link&external_id=999999&username=test9999&first_name=API&last_name=TEST&phone=4093334444@email=test@example.com" https://example.com/service

Request

NameTypeRequiredExample
external_idStringYabc123

The external user ID, used to uniquely identify this user between the two systems (required)

usernameStringYjohndoe

The username of the customer (alphanumeric and dashes). This cannot be left blank if automatic user creation is desired.

passwordStringNPass123

Not required. If provided, the password must contain at least 7 characters and include at least one uppercase letter, one lower case letter, and one number

first_nameStringYJohn
last_nameStringYDoe
phoneStringY8005551234
emailStringYjohn.doe@example.com
companyStringNDoe Enterprises
account_typeStringNCustomer

An optional/custom account type. If "User" (the default), this can be omitted.
@pair_existing String N 0 | If set to "1" THEN existing/conflicting usernames will be paired instead of returning an error if BOTH username and email address match

date_addedDate StringN2014-01-01 13:59:00

YYYY-MM-DD HH:MM:SS
A custom date of creation
(If omitted, assumes the current server date and time)

Response

NameTypeExample
user_idInteger1001

The new internal ID used by this system. It is not required that you store this value as we will store your external_id in association with this account.

ai_sidInteger31754

The session keys passed to assume the newly logged-in session
session keys must be used promtply after generating them so this API should be called right before redirecting the user
see the returned 'dashboard_url' for an example of how to use the session key paramaters

ai_sid_keyStringi1e9hr978d
dashboard_urlStringhttp://domain.com/dashboard?ai_sid=31754&ai_sid_key=i1e9hr978d

The URL you may use to send this user to our dashboard page
@example commandline