Knowledgebase : Customization & Integration
Login Share, what is it and how to set it up
Posted by Andres M. on 16 March 2015 11:27 am

Login Share is the name of the system and API in HelpDeskZ that enables user authentication against a separate system. This is done using an API.

With Login Share you can integrate your HelpDeskZ product with any third party applications. If you already have backend systems and user databases available, this enables you to let your users dive right in, without registering another account.

 How it works

  1. The user fills in a login form
  2. HelpDeskZ sends the username, password, and the user's IP address as a  POST to the Login Share script
  3. The LoginShare script replies with an XML packet
  4. If a user is successfully authenticated and the account doesn't exist in HelpDeskZ, it is created based on the details received in XML response
  5. If a user is successfully authenticated and a matching account already exists in HelDeskZ, the account is updated with the details received in the XML response

Setup Login Share

  1. Login to admin panel and go to Settings -> General -> Security
  2. Set Use Login Share to Yes
  3. In Login Share URL enter the url where the authentication script is located, for example: http://mysite.com/helpdeskz_auth.php

Authentification successful

This is the format of the result:

<?xml version="1.0" encoding="UTF-8"?>
<loginshare>
            <result>1</result>
            <user>
                <fullname>John Smith</fullname>
                <email>john_smith@demo.com</email>
            </user>
</loginshare>

Authentification script example

<?php
$fullname = 'John Smith';
$email = 'smith@mysite.com';
$password = 'mypassword';
if($email == $_POST['email'] && $password == $_POST['password']){
    header('Content-Type: application/xml; charset=utf-8');
    echo '<?xml version="1.0" encoding="UTF-8"?>
    <loginshare>
        <result>1</result>
        <user>
            <fullname>'.$fullname.'</fullname>
            <email>'.$email.'</email>
        </user>
    </loginshare>';
}
?>

 

We prepare some LoginShare modules for Wordpress and Magento, you can take a look in our Forum to download.