By assigning a referrer by URL to a user, we allow them to enter the store without logging in or identifying themselves. The most common cases are when access to an institution is sold so that all students enter through the same network, or to integrate with an additional platform such as an intranet.
Before starting the configuration we must have the Referral URL that we want to assign. If the case is for an institution, you must previously ask them for the URL(s) from which the users will be referred (it is the same URL that is seen on the last screen the user accesses before being redirected to the store).
We recommend you review HERE our technical documentation.
📹 Here you can see a complete instruction
1. Tell the University or your client the URL of the store. Your client will use it to redirect users from the site where it will do the redirection. This URL must be placed in the Button or Link where the user will click to access the store.
For example: if the integration will be carried out with a university, campus administrators must add a button or link like "Access the virtual library of..." and place the URL of the store).
👉To the store URL you must add the corresponding route as shown below:
For example: https://alephdigital.publica.la/auth/referrer
It is very important that the URL that you share with your clients is well constructed to avoid integration errors.
In case the link is required to lead to specific posts, you should build the URLs as follows:
URL of your library: https://tubiblioteca.com/auth/referrer
Parameter separator: ?intended_url=
Publication URL: https://tubiblioteca.com/reader/comportamiento-organizacional-1
Finally the url would look like this:
2. You must identify that customer with a user in the store. For this you must:
a. From Control Panel > Users, create a user in the store (if you haven't done so yet) or search for it if it's already created.
💡 Remember that you must assign a specific plan for that client.
b. Click the dropdown menu (next to Edit) and select Assign Referrers by URL:
c. Add the URL received from the institution and click Assign . You must repeat this for all the different URLs from which they want to access:
Considerations to take into account when adding the URLs:
*You can add the URL followed by a slash and an asterisk (/*) to indicate to the system that all URLs beginning with this will have access to the store and the content assigned to the user. This will prevent errors when students try to enter the store.
👉For example https://www.institucion.com/*
The referring URL must contain the protocol https:// or http:// at the beginning of it to avoid errors.
For greater security: the link or button with the URL of the store must be used on a platform with access to registered users . This prevents it from being open to the general public and from any user being able to access the content.
d. Indicates the number of concurrent user sessions. Position yourself on the user and click on Edit to configure the limit of concurrent sessions .
Keep in mind that if you do not add this value, the store's default limit (3) will be taken and if more users want to access, they will be asked to login.
3. Ask the customer to test to verify that the integration has been set up correctly.
In the event that it does not work at the time of validation, we recommend following the steps below:
Confirm with the institution that the indicated URL corresponds to the last URL from which users will click the button or link to be directed to the store.
Verify that the institution has correctly added the URL you provided to send users to the store. Remember that it must have the extension /auth/referrer
at the end 👉For example: https://alephdigital.publica.la/auth/referrer
Go to Control Panel > Users , search for the user to whom the URL has been assigned, go to Edit and verify that the number of simultaneous sessions of that user is a high number or the number that has been discussed with the institution.
If this field has no value, the default limit will be used and students will not be allowed to enter simultaneously through. High values are recommended.
If these checks fail to identify the error, we invite you to review this help article with an advanced check to verify if the URL is being sent correctly. Do not use or do the tests from a window in "incognito mode" or "private browsing" as this could cause problems for proper functioning.
We hope this tutorial has been easy for you. If you have questions, write to us at [email protected] .