> ## Knowledge Base Index > Fetch the complete knowledge base index at: https://help.mimeeq.com/sitemap.xml > Use this file to discover available pages before exploring further. > Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash). # Mimeeq Authentication: User Guide ### Overview This guide explains how to implement secure user authentication for your Mimeeq product configurators in the simplest way possible. By following these steps, you'll allow your customers to log in, access their private prices, saved (favourite) configurations, and manage their user Profiles. **Key Benefits:** * Secure access to your Mimeeq configurators * Easy implementation with minimal technical knowledge * Support for multiple languages * Built-in password recovery functionality ### Getting Your Authentication Code The first step is to obtain your unique Mimeeq authentication code from your admin panel: 1. **Access the Admin Panel** * Log in to your Mimeeq admin dashboard * Navigate to Settings → Customer settings * Click on "Code" in the left sidebar * Select "Login Code" 3. **Copy the Authentication Code** * You'll see an "Embed Code snippet" dialog * Click the "Copy Script" button to copy the complete authentication code * This code contains both your unique customer ID and the script that loads the authentication system 5. **Customize Settings (Optional)** * Before copying, you can: * Select your preferred language from the dropdown * Choose theme options to match your website's design * Toggle "Use default page font" will allow for our login modal to use your page font ### Step-by-Step Guide: Adding Authentication to Your Website **Step 1: Add the Authentication Code to Your Website** 1. Paste the complete authentication code (that you copied using "Copy Script") into your website's HTML 2. Place it in the section of your website for best performance 3. This code only needs to be added once per page where authentication will be used ``` ``` ```

``` ###### Step 2: Set Up Authentication URL Links The simplest way to enable login functionality is by creating links that add ?auth=mimeeq to your website URL: `https://your-domain.com/?auth=mimeeq` When users click a link with this parameter, the login modal will automatically open without any additional HTML elements needed. ###### How to Implement: 1. **Create Login Links** Create a login or "My Account" button/link on your website that adds this parameter to the URL:These links can be created from any button or element on your exisiting page 2. `Login` Or for a specific page: `My Account` 2. **Common Use Cases:** * Add a "Login" button in your navigation menu * Create "My Account" links in your website footer * Add login links on product pages ###### Managing User Authentication **One Link for Both Login and Logout** One of the major benefits of the URL authentication method is that the same link handles both login and logout automatically: 1. **For Users Not Logged In**: When someone clicks the ?auth=mimeeq link and they're not logged in, they'll see the login modal 2. **For Users Already Logged In**: When someone clicks the same link and they're already logged in, they'll see a prompt with options to log out or cancel This means you only need to implement a single "Account" or "Login" link on your website. The Mimeeq authentication system intelligently handles the user's state and shows the appropriate modal. in other words no additional code is required to handle these different states - the authentication system manages everything automatically. ###### Language Support Mimeeq's authentication supports multiple languages: 1. The language is determined by the locale attribute in your authentication code (e.g., locale="en" for English) 2. To set or change the language: * In the Admin Panel: Select your preferred language in the Embed Code snippet dialog before copying the code * The language setting appears in the shortcode portion as locale="en" (where "en" represents your selected language code) 4. The language you select will affect all text in the authentication modals ###### Setting Up Partner Login Redirect URL When users signs-up for the first time through the mimeeq authentication system, you can automatically redirect them back to your website. This provides a seamless experience for your customers. 1. **Configure the Partner Login Page URL** * In your Mimeeq Admin Panel, go to Settings → Customer settings * Look for the "Partners Login Page" field * Enter the URL of your website where users should be redirected after authentication * This URL should include the ?auth=mimeeq parameter to automatically open the login modal upon redirect When a user completes the authentication process, they will be automatically redirected to this URL, which will immediately open the login modal thanks to the ?auth=mimeeq parameter. ###### Inviting Users to Your Platform You can invite users to register on your platform with Mimeeq authentication: 1. For detailed instructions on how to invite partner users, refer to our dedicated guide: [Invite a Partner User (Client/Tier2)](https://help.mimeeq.com/en/article/invite-a-partner-user-client-tier2-jik7z7/) ###### Customizing the Login Appearance Before copying your authentication code, you can customize its appearance: 1. In the Admin Panel's Embed Code snippet dialog: * Use the "Button color override" to set the primary button color * Use the "Button text color override" to set the text color on buttons * Toggle "Use default page font" to match your website's typography 3. These settings will be applied to all authentication-related elements on your site ###### Common Questions **Q: Where can I find my authentication code?** A: In your Mimeeq Admin Panel under Settings → Customer settings → Code → Login Code. **Q: Do I need to add the authentication code to every page?** A: Yes for the best experience, you should add it to every page where users might click a login link. The code is lightweight and loads asynchronously, so it won't affect your page performance. **Q: What happens after a user logs in?** A: Users will be able to access their saved configurations and personalized features of your Mimeeq configurator. **Q: How do I know if authentication is working properly?** A: Test the login process by clicking your authentication URL link and verifying that the login modal appears and works correctly. **Using Authentication URLs Effectively** The authentication URL approach (?auth=mimeeq) offers several advantages: 1. **Simplicity**: No need for complex code or custom development 2. **Consistency**: The login experience is the same across your entire website 3. **Flexibility**: Works with any website platform or content management system 4. **User Experience**: Clean interface that doesn't disrupt your website design Best practices for implementing authentication links: 1. **Prominent Placement**: Add login links in your main navigation for easy access 2. **Clear Labeling**: Use text like "Login," "My Account," or "Sign In" for your links 3. **Consistent Location**: Place authentication links in the same location across your site 4. **Mobile Friendly**: Ensure authentication links are accessible on mobile devices **For Developers: Programmatic Authentication** If you have a developer on your team who needs more advanced implementation options, Mimeeq provides a comprehensive API for programmatic authentication: **Advanced Features for Developers:** * Custom login forms and interfaces * Programmatic authentication flows * User data access and management * Custom authentication state handling * Integration with existing user systems For complete technical documentation on programmatic authentication methods, please visit:[https://docs.mimeeq.com/auth-introduction](https://docs.mimeeq.com/auth-introduction) For additional assistance with Mimeeq authentication, please contact our support team at **support@mimeeq.com** or visit our [Help Center](https://help.mimeeq.com/).