JavaScript

Features ›› Authentication ›› requestOTP ›› Sample Code ››
Parent Previous Next

Request OTP


When the "Send" button is clicked, the webpage will perform basic validation, then use the given details to call the API, with service name "requestOTP".

If there are no errors with the information provided, the webpage will proceed to parse a JSON string from "requestOTP" into "responseObj"


We will be able to import useful data from these 3 sources, and to call a function and store the user ID and PIN.






getUserID&getPIN


This code required data variable from Jsp, please refer to getUserID&getPIN above.



We will create a function and a header. The header will contain servicename, userID, PIN.

Then we will get and validate those values we have so far.



setUserID&setPIN


This code required data variable from Jsp, please refer to setUserID&setPIN above.


showErrorModal


This code required data variable showErrorModal from Jsp, please refer to showErrorModal above.



We will disable Send button



We will set a header object

.

The header object contains:


Then will use JSON to convert headerObj into var header.



xmlHttp


This code required data variable xmlHttp from Jsp, please refer to xmlHttp above.


ApiURL


This code required data variable ApiURL from Jsp, please refer to ApiURL above.



Set up http request.

If xmlHttp is equals to nothing, the web page will display an alert message:"Browser does not support HTTP request."

If xmlHttp is not equal to nothing, the web page will return data from the url and the header."

The timeout will be 5000s.



xmlHttp


This code required data variable xmlHttp from Jsp, please refer to xmlHttp above.


ApiURL


This code required data variable ApiURL from Jsp, please refer to ApiURL above.


Setup http event handlersIf globalerrorID = "010041", return OTP. Else if globalerrorID not = "010000", return error details.



onreadystatechange


This code required data variable onreadystatechange from Jsp, please refer to onreadystatechange above.


xmlHttp


This code required data variable xmlHttp from Jsp, please refer to xmlHttp above.


showOTPModel


This code required data variable showOTPModel from Jsp, please refer to showOTPModel above.


showErrorModal


This code required data variable showErrorModal from Jsp, please refer to showErrorModal above.


Display "OTP Sent"




We will enable "Send" button.

Once the time is out, it will show error modal: "Timeout invoking API."

Then send the http request.



xmlHttp


This code required data variable xmlHttp from Jsp, please refer to xmlHttp above.


ontimeout


This code required data variable ontimeout from Jsp, please refer to ontimeout above.


showErrorModal


This code required data variable showErrorModal from Jsp, please refer to showErrorModal above.



Button will be disabled when there is an error occurs.




OTP model update button clicked



setOTP


This code required data variable setOTP from Jsp, please refer to setOTP above.



Overview of “Request OTP” function


<h2 class="page-header" style="color:#937851">Request OTP</h2>


<div class="container">

   <div class="col-md-6">

       <div class="row">

           <h3 style="color:#937851">Input</h3>

       </div>

       <form class="form-horizontal well" style="padding-bottom: 0px;">

           <div class="form-group">

               <div class="col-sm-offset-4 col-sm-4">

                   <button id="Send" type="button" class="btn btn-primary">Send</button>

                   <button type="reset" class="btn btn-default">Clear</button>

               </div>

           </div>

           <div class="form-group">

               <label for="userID" class="col-sm-4 control-label">User ID</label>

               <div class="col-sm-4">

                   <input id="userID" type="text" class="form-control"/>

               </div>

           </div>

           <div class="form-group">

               <label for="PIN" class="col-sm-4 control-label">PIN</label>

               <div class="col-sm-4">

                   <input id="PIN" type="password" class="form-control"/>

               </div>

           </div>

       </form>

   </div>

   <div class="col-md-6">

       <div class="row">

           <h3 style="color:#937851">Output</h3>

       </div>

       <form class="form-horizontal well" style="padding-bottom: 0px;">

           <div class="form-group">

               <div class="col-sm-offset-4 col-sm-4">

                   <button type="reset" class="btn btn-default">Clear</button>

               </div>

           </div>

           <div class="form-group">

               <label for="status" class="col-sm-4 control-label">Status</label>

               <div class="col-sm-4">

                   <input id="status" type="text" class="form-control" disabled/>

               </div>

           </div>

       </form>

   </div>

</div>


<!-- javascript libraries

======================================== -->

<script src="assets/js/jquery.min.js"></script>

<script src="assets/js/jquery-ui.min.js"></script>

<script src="assets/js/bootstrap.min.js"></script>


<script type="text/javascript">


   $(document).ready(function () {

       

       // init user credentials

       document.getElementById("userID").value = getUserID();

       document.getElementById("PIN").value = getPIN();


       /*----------------------------------------

        * [Send] button clicked

        */

       $("#Send").click(function (event) {

           (function() {


               // set service header values

               var serviceName = "requestOTP";

               var userID = document.getElementById("userID").value;

               setUserID(userID);

               var PIN = document.getElementById("PIN").value;

               setPIN(PIN);

               

               

               // disable Send button

               //document.getElementById("Send").disabled = true;


               // set request parameters

               var headerObj = {

                   Header: {

                       serviceName: serviceName,

                       userID: userID,

                       PIN: PIN,

                       OTP: ""

                   }

               };

               

               var header = JSON.stringify(headerObj);


               // setup http request

               var xmlHttp = new XMLHttpRequest();

               if (xmlHttp === null){

                   alert("Browser does not support HTTP request.");

                   return;

               }

               xmlHttp.open("POST", getApiURL()+"?Header="+header, true);

               xmlHttp.timeout = 5000;


               // setup http event handlers

               xmlHttp.onreadystatechange = function() {

                   if (xmlHttp.readyState === 4 && xmlHttp.status === 200) {

                       responseObj = JSON.parse(xmlHttp.responseText);

                       serviceRespHeader = responseObj.Content.ServiceResponse.ServiceRespHeader;

                       globalErrorID = serviceRespHeader.GlobalErrorID;

                       if (globalErrorID === "010041"){

                           showOTPModal();

                           return;

                       }

                       else if (globalErrorID !== "010000"){

                           showErrorModal(serviceRespHeader.ErrorDetails);

                           return;

                       }

                       

                       // display data

                       document.getElementById("status").value = "OTP Sent.";


                       // enable Send button

                       //document.getElementById("Send").disabled = false;

                   }

               };

               xmlHttp.ontimeout = function (e) {

                   showErrorModal("Timeout invoking API.");

                   return;

               };                                        


               // send the http request

               xmlHttp.send();


           })();

       });


       /* ----------------------------------------

        * error model close button clicked

        */

       $("#CloseError").click(function (event) {

           (function() {

               document.getElementById("Send").disabled = false;

           })();

       });


       /* ----------------------------------------

        * OTP model update button clicked

        */

       $("#UpdateOTP").click(function (event) {

           (function() {

               var OTP = document.getElementById("OTP").value;

               setOTP(OTP, function() { // ensure OTP set before clicking Send

                   document.getElementById("Send").disabled = false;

                   document.getElementById("Send").click();

               });

           })();

       });


   });


</script>



requestOTP




Created with the Personal Edition of HelpNDoc: Free iPhone documentation generator