OpCode T: Create a Login Ticket for the specified User
OpCode T: Create a Login Ticket for the specified User
This opcode is used to create a login authorization ticket that is valid for one (1) minute. This ticket token can then be returned to the client browser with a specific redirect URL, allowing the client to launch the show without having to transmit the API credentials to their browser. The redirect should be temporary (HTTP 302) to the URL described below. Both attendees (default) and exhibitor users can be specified. The user must already exist. If LookupByExternalUserID is specified as one (1), then the user is located based on the ExternalUserID value. Otherwise, the user is located based on EMailAddress. Several conditions would prevent successful login ticket creation, such as the user’s account being inactive or the user not being registered for the show.
Calling The API
The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation. Each request must supply the authentication credentials assigned to the caller by Notified. Only requests with valid credentials will be processed. These credentials identify the caller and provide access only to a specific customer area.
The format of the call is: https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50500&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCodeList={Opcode[OpCode[…]]}&OutputFormat={X|H|T(default)}&LookupByExternalUserID={0(default)|1}&{Additional, opcode-specific parameters in name=value format…}
Note: The format of the APAC Data Center is: https://api.apac.onlinexperiences.com.
Specific parameter ordering is unimportant, with the only restriction being that the first parameter MUST BE LASCmd=AI:4;F:APIUTILS!50500. All other parameters may appear in any sequence.
API Parameter | Type/Size | Req. | Comment |
---|---|---|---|
APIUserAuthCode | Varchar 80 | Y | Your API authorization code as supplied by Notified. |
APIUserCredentials | Varchar 80 | Y | Your API user credentials as supplied by Notified. |
OpCodeList | Varchar 20 | Y | Should include I to invoke this function. |
OutputFormat | Char 1 | N | T for text, H for HTTP URL-encoded, or X for XML. Defaults to T. |
LookupByExternalUserID | Bit (0/1) | N | Pass one (1) to look up this person by the supplied ExternalUserID (your internal identifier). |
ExternalUserID | Varchar 255 | - | Your internal identifier for this person. This value must be unique for each person. |
EMailAddress | Varchar 255 | - | The person’s email address. |
ShowKey | Integer | Y | The show identifier to launch. |
ShowLaunchInitialDisplayItem | Varchar 20 | N | The show module to navigate to upon launch of the show. This consists of a type prefix followed by an item key. The valid type prefixes are S for Show Floors, E for Events, EL for Event Lobbies, EH for Event in the main show area, B for booths, D for documents/links, G for group chats, M for message boards, and U for User Profile, V for video/SelfieCast. If the type prefix is B for a booth, then the following item key must be a valid booth key (ex: B9336). A special case code of C may be used to navigate to a booth and join a private chat. |
ShowLaunchErrorRedirectURL | Varchar 500 | Optional URL to redirect users to if the show launch fails. Embedded variables $[ShowKey]$, $[DisplayItem]$, $[LangLocaleID]$, $[ErrorMsg]$ and $[ShowName]$ may be placed in this URL, and will be replaced by the system. |
Return Outputs
This API returns the status message OK upon successful completion, as well as the LoginTicketKey value to be used when constructing the redirect URL.
Text
### APICallResult=0 APICallDiagnostic=OK OpCodesProcessed=1 OpCodesInError=0
## OpCode=T Status=0 Message=OK
LoginTicketKey
12345
HTTP URL-encoded
APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1&OpCodesInError=0&OpCode=I&Status=0&Message=OK&LoginTicketKey=12345
XML
<?xml version="1.0" encoding="utf-8" ?>
<APIResults APICallResult="0" APICallDiagnostic="OK" OpCodesProcessed="1" OpCodesInError=”0” >
<OpCodeResult OpCode="T" Status="0" Message="OK" >
<ResultRow>
<LoginTicketKey>2574F936-DD4B-4451-A8A5-F420C03E5306</LoginTicketKey>
<RecipientKey>123456</RecipientKey>
</ResultRow>
</OpCodeResult>
</APIResults>
After retrieving the LoginTicketKey value, the redirect URL can be constructed as follows:
https://onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50505&LoginTicketKey={value}
The tag {value} is replaced with the LoginTicketKey value returned from the API call. Note the difference in domain name in the redirect link (onlinexperiences.com vs api.onlinexperiences.com).
Potential Error Codes
Error | Message | Reason |
---|---|---|
71 | User Not Found! | The user with either the specified ExternalUserID or EMailAddress could not be found. |
72 | User Account Is Inactive! | The specified user’s account is marked inactive. |
73 | Error Creating Login Ticket! | An error occurred while creating the login ticket. Please contact support. |
74 | User Is Not Registered For Show! | The show requires registration and this user is not registered. |
75 | Invalid Initial Display Booth Specified! | If the optional parameter ShowLaunchInitialDisplayItem is specified and the first character is B, then the characters following the B must correspond to a valid booth key for the specified show. |
76 | Invalid Initial Display Event Specified! | If the optional parameter ShowLaunchInitialDisplayItem is specified and the first character is E, then the characters following the E must correspond to a valid event key for the specified show. |
77 | Invalid Initial Display Show Floor Specified! | If the optional parameter ShowLaunchInitialDisplayItem is specified and the first character is S, then the characters following the S must correspond to a valid show floor key for the specified show. |
- | Presentation not currently available. The next run time is 12:00 AM on November 1, 2020. | Attempt to deep-link to a presentation that is not open due to dates/times. |
78 | User Already Logged In! | The specified user is already logged in. |
79 | Temporary Password Flag Is Set! | The user must reset their password. |