One Click Access
One Click Access is used to create a link href or set as iFrame source that you can give your users for seamless access for new registration or logging into their member page. Using a variety of URL parameters, you are able to send key identity and demographic information about your members. You are also able to use parameter sets in the URL to control the logic. This article provides you with all the information you need to create and customize your One Click Access link.
Base URL and Parameters
Accessing your Base URL link
To get started using the One Click Access feature, follow these steps to retrieve your link:
- Log into your account and go to the Program details page.
- Under Integrations, select either Standalone Site, Widget, or iFrame.
- Scroll down to the One Click Access section and copy the Base URL link.
- Add desired Parameters to the link.
- Paste this link into your desired location.
To customize your Base URL link so that it will pull the necessary information to sign up or login your members, you will need to add parameters to the link. Here is a template of how to configure your One Click Access link:
One Click Access = [Your Base URL] + ?Parameter = value.
Each parameter needs to individually be encoded. This is so odd characters don't get messed up in the URL/browser. This can be done in a variety of ways, depending on your coding environment.
Identity and Demographic Parameters
You can customize your One Click Access link to pull key identity and demographic information about your members by adding any of the parameters below.
Here are some examples:
- Which program they should be in
- An external ID for the member/user so you can match them in your system.
- Name, email address, birthdate, phone, or other demographic information
|Field||Values||Notes||Required When adding a Member?||Required for One Click Access?|
|programidentifier||String||Can be Program Name, Title, Program ID.||Yes||Yes|
|externalid||String||Used to reference user by ID (Usually your ID for the user).||No||Conditionally required if email is not provided.|
|fullname||String||Full names will be parsed into first and last , with a single space between.||No||No|
|firstname||String||Minimum 3 character||Yes||No|
|String (Valid email address)||Yes||Conditionally required if external ID is not provided|
|birthdate||String (Parsed to a date)||No||No|
Optional Control Parameters
You can also add parameters to control the logic of your link.
Here are some examples:
- Should the URL open a iframe friendly page, the widget, or a full page?
- If the user doesn’t exist, should the system add them?
- Should I update demographic information on the member if they existed? This is a good way to keep all the data in sync between the systems.
|Field||Default Value||Values||Notes||Required when Adding a Member?||Required for One Click Access?|
|sendregemailonadd||programrules||programrules, true, false||If value = program rules, it follows the rules of the program||No, uses default||No, uses default|
|updatemember||false||true, false||If member exists, it will update member with demographic info provided||Not affected||No, uses default|
|view||site||site, widget, iframe||Redirects to either site, widget or iframe||No, uses default||No, uses default|
|addmember||true||true, false||Adds member if user does not exist by external id or email.||No, uses default||No, uses default|
|deniedpage||goes to codenotavailable|
.aspx page on your Referral Rock site
|String URL||Redirects to page if access is denied||No||No|
|debug||true||true, false||Instead of redirecting, displays access link generated and all debug info, parameters, on page.||No, uses default||No, uses default|
|true||true, false||If the first name is missing, we'll replace it with the email address.||No, uses default||No, uses default|
|true||true, false||If we fail to login/add user we will direct the link to the registration page of that program. Note, the programidentifier must be set correctly.||No, uses default||No, uses default|
It’s important to debug your link to make sure it is working correctly and pulling all the correct data. The debug parameter is used to display access link generated data, debugging information, the result of the one-click access link (did it fail, succeed, etc.) and a message detailing the results.
One Click Access Flow
When you have successfully created and customized your One Click Access link, it should follow the below flow.