Direct Loyalty Functions (ameliaSOAR Integration)
- Kristian Luck
- Duy Doan
Many clients choose to operate and manage a corporate website / mobile site themselves. When taking this approach, they often want to permit visitors to directly do operations with respect to their loyalty/frequent flyer account. Such operations include: Forgot password, Login, Register new account (Signup). In the case of ameliaSOAR, this is facilitated by a number of URLs with particular querystring parameters. The sections below provide the required information for a client to directly transfer to ameliaSOAR to achieve the aforementioned operations.
Forgot Password
Example URL: https://intelisys-soar.intelisysmaint.ca/?forgotPassword=true&language=en
| Field Name | Description | Required or Optional | Format / Example |
|---|---|---|---|
| forgotPassword | Indicates that the user has forgotten their password and therefore wants to request a password reset. | required | e.g. true |
| language | Language code to indicate what language the IBE should be initially displayed in. | optional | e.g. en |
Login (Loyalty)
Example URL: https://intelisys-soar.intelisysmaint.ca/login?language=en
| Field Name | Description | Required or Optional | Format / Example |
|---|---|---|---|
| language | Language code to indicate what language the IBE should be initially displayed in. | optional | e.g. en |
Login (deprecated)
Example URL: https://intelisys-soar.intelisysmaint.ca/?login=true&language=en
| Field Name | Description | Required or Optional | Format / Example |
|---|---|---|---|
| login | Indicates that the user should be presented the login dialog as soon as they enter ameliaSOAR. | required | e.g. true |
| language | Language code to indicate what language the IBE should be initially displayed in. | optional | e.g. en |
Login - user cannot close the login dialog
This operation is very similar to the Login operation but the user must complete the login to proceed within ameliaSOAR. In other words, the user cannot close the login dialog.
Example URL: https://intelisys-soar.intelisysmaint.ca/?requireLogin=true&language=en
| Field Name | Description | Required or Optional | Format / Example |
|---|---|---|---|
| requireLogin | Indicates that the user should be presented the login dialog as soon as they enter ameliaSOAR, and they cannot close that dialog. Therefore, the login is required. | required | e.g. true |
| language | Language code to indicate what language the IBE should be initially displayed in. | optional | e.g. en |
Register New Account (Signup)
Example URL: https://intelisys-soar.intelisysmaint.ca/?register=true&language=en
| Field Name | Description | Required or Optional | Format / Example |
|---|---|---|---|
| register | Indicates that the user should immediately be taken to the "loyalty registration" page/dialog within ameliaSOAR. | required | e.g. true |
| language | Language code to indicate what language the IBE should be initially displayed in. | optional | e.g. en |