MEMBER CONSOLE
«Member Console» — special online application, enabling your clients to get information on
earned bonus points, real activity record, for example, purchases history and active offers of your company.
Run the console in demo mode.
To get authorized access to
«Member Console» your clients need to obtain individual account and password.
Ways to provide accounts for your customers
- You can automatically create accounts for your members.
-
Your clients can register in the system on their own.
For registration they will need to provide a minimal set of personal information: name, last name, email and password.
«Member Console» access address
-
«Member Console» application can be placed directly on your web site. You will need just to add
a special «Member Console» widget.
Example.
-
Your clients can use «Member Console» from PointLoyalty web site directly after registering there on their
own or getting their accounts credentials from your company.
Customization of «Member Console»
You can place your company logotype on the console and customize its appearance by supplying custom CSS.
Compare
standard «Member Console» design with
customized one.
STEPS TO PROVIDE YOUR CLIENTS WITH ACCESS TO THE «MEMBER CONSOLE»
1. Transfer to the PointLoyalty system a list of your clients.
An example of minimal set of information on your client:
| memberId |
Client identifier used in client transactions data, for example,
discount card number or internal client identifier within your internet shop.
|
| email |
Email address required for notification on earned bonus points etc.
|
| personalId |
Personal client identifier, required to join your programs.
Can be equal to memberId.
|
| other attributes |
Optional data, to create loyalty offers based on client attributes. Details...
|
Example:
| memberId |
john |
| email |
john@mail.com |
| personalId |
john |
Ways to submit the data:
REST API,
Web Services,
XML data files,
manual input.
2. Create client account or let your clients to register in the «Member Console» on their own.
To create accounts automatically use
REST API
or
Web services.
Example of client data set:
| name |
john |
| password |
john_password |
| email |
john@mail.com |
| firstName |
John |
| lastName |
Doe |
| timeZoneId |
Depends on John Doe's time zone |
| personalId |
john |
You can provide your clients with URL address which they will use for registration –
PointLoyalty web site page or a page within your site, where you place «Member Console» widget.
Integration hints (if you create accounts automatically)
If your clients already have accounts in your own system – you can use that credentials to create «Member Console» accounts.
To ensure data security you might employ encryption, for example, use
MD5 (
algorithm description,
implementation sample)
data transformation.
Example: let's assume
username in your system =
test,
password in your system =
test
Create an account for this client using
REST API
with
username =
test and
password =
MD5 (test).
If you don't want to depend on potentially changeable data - use
MD5
transformation of your internal client identifier as a password.
After client logon to your system for «Member Console» access from your application specify
username,
MD5 (password)
as widget input parameters and client will login to the «Member Console» automatically.
TECHNICAL PROPERTIES OF «MEMBER CONSOLE» WIDGET
1. See
instructions on how to place the
widget on external web site page and a demonstration
example.
2. JavaScript functions invoked from the Console.
| onLoad |
No parameters |
Invoked after loading the application |
| onLogin |
No parameters |
Invoked after successful login to the application |
| onLogout |
No parameters |
Invoked after logout from the application |
| onError |
String. Optional. Error reason. |
Invoked in case of application errors |
3. Console parameters.
| register |
true/false. False by default. Run the application and proceed to registration form. |
| demo |
true/false. False by default. Run the application in demo mode. |
| name |
Client name. Login as this user. |
| pswd |
Client password. Login as this user (see name). |
Examples of parameters:
- http://yoursite.com/member.swf?client-name=yourname&name=john?pswd=789JNK345
- http://yoursite.com/member.swf?client-name=yourname®ister=true
4. Change your profile in
PointLoyalty Manager
and update settings for customizing Member Console appearance.
| Allow member access |
Allow/disable editing «Management client access» section. |
| Authentication type |
If your clients register in the system by themselves then to join your loyalty programs they will need to
provide their personal identifiers and (if required) passwords.
Choose authentication type depending from the set of client data,
which you send to the system.
Pay attention that if you choose «Sole owner» option and create member accounts automatically it is enough to choose «By identifier» option.
|
| Common identifier |
Choosing this option tells the system that client identifiers passed for bonus processing within transactions data
coincides with personal identifiers for joining clients to loyalty programs.
If you create client accounts automatically, choosing «Common identifier» option is most convenient.
If your clients register in the system themselves - you need to provide them separate personal identifier since
complex identifier used in transactions (encrypted card number for example) can be too complex for manual input in the
«Member Console» application.
|
| Notify members |
Should the system send emails with information on earned bonus points and processed bonus corrections.
|
| Sole owner |
Allow your clients to join loyalty programs of other vendors («no» - if you don't send client data
together with partners who have their own programs).
|
| Disable editing profile |
If you are a «Sole owner» and have automatic login to «Member Console» from your system you might want to
disallow your clients to edit personal data (including password) in «MemberConsole» application.
Choose this option if you integrate «MemberConsole» with your application having authentication system.
|
| Disable logout from Member Console |
If you are a «Sole owner» and have automatic login to «Member Console» from your system you might want to
disallow your clients to quit «MemberConsole» application.
Choose this option if you integrate «MemberConsole» with your application having authentication system.
|
| Support email |
You can specify your company support service email to display it on the «Member Console». |
| Encryption |
If you use credit card numbers for client identification and «Common identifier» option - clients
will need to specify this card number when joining your programs.
The system needs to know what encryption type you use to not to store real card numbers.
If you automatically create client accounts - choose «Without encryption» option (Clients will
automatically join your loyalty programs and don't need to enter personal identifier).
|
| «Member Console» logo |
Clients will see «Member Console» with your logotype (if you place it on your site).
|
EXAMPLES - HOW TO WORK WITH MEMBER CONSOLE
Example 1. Internet shop.
-
You have an internet shop with client authorization system and want to do an integration with «Member Console».
-
You plan to create accounts for your clients automatically.
-
An example of your client registered in your internet shop:
| firstName |
John |
| lastName |
Doe |
| username |
john |
| password |
john_password |
| email |
john@mail.com |
-
All transactions you submit using memberId = username (john)
-
You don't plan to have coalitions with other companies having their own loyalty programs.
Recommendations:
Recommended parameters for managing client access
| Allow client access |
yes |
| Authentication type |
«By identifier» |
| Common identifier |
yes |
| Notify client |
If required |
| Sole owner |
yes |
| Disable changing personal data |
yes |
| Disable exit from console |
yes |
| Support service |
support@yourcompany.com |
How to pass information about your clients into the system:
1. You can pass the data on your clients using
REST API,
Web Services or using
XML files.
| memberId |
john |
| email |
john@mail.com |
| password |
skip this field |
| personalId |
john |
2. Create client accounts automatically (for example, when registering new clients in your system) using
REST API or
Web Services
| name |
john |
| password |
john_password
or MD5 (john_password)
|
| email |
john@mail.com |
| firstName |
John |
| lastName |
Doe |
| timeZoneId |
Depends on time zone of John Doe |
| personalId |
john |
Example 2. Information and advertisement site.
-
You have internet resource without client authentication - just for information and advertisement.
-
You don't need to create client accounts automatically.
-
All transactions you process using loyalty card numbers of your clients.
-
You don't plan to have coalitions with other shop owners having their own loyalty programs.
Recommendations:
Recommended parameters for client access management
| Allow access for your clients |
yes |
| Authentication type |
«By email» |
| Common identifier |
yes |
| Notify clients |
When required |
| Sole owner |
yes |
| Disable client personal data change |
no |
| Disable quitting system exit |
no |
| Support service |
support@yourcompany.com |
Client information
1. You can pass client information to the system using
REST API,
Web Services or using
XML files.
| memberId |
MD5 (loyalty_card_of_doe) |
| email |
john@mail.com, you should take it from your clients when issuing loyalty cards, etc.
You need it since authentication type is by «By email»
|
| password |
skip this field |
| personalId |
MD5 (loyalty_card_of_doe) |
Pay attention that since you operate mainly offline you'll need to get clients personal data (for example when issuing loyalty cards).
You need to get at least a minimal set of data such as email, name, last name and a card number to associate transactions with your clients.
Besides, you need to give to your client his personal identifier for joining your loyalty programs.
For example, you need to explain to your client that he will need to enter his loyalty card number when registering in the «Member Console».
2. You offer to your clients to proceed to the page on your web site where you placed «Member console» widget.
After the registration a client enters his
personalId (card number) and join your loyalty program.
