User Tools

Site Tools


integration-api:start

This is an old revision of the document!


ADUCID Integration API

Integration API is an essential part of ADUCID for all web browser scenarios. It connects PEIG, AIM and the browser. Integration API is an essential component of ADUCID Binder, No-code transactions and many other components.

Integration API is located in aducid-resurces folder (on Tomcat). It requires jQuery and API js and css files:

 <script type="text/javascript" src="/aducid-resources/js/jquery.min.js"></script>
 <script type="text/javascript" src="/aducid-resources/js/aducid-api.js"></script>
 <link type="text/css" media="screen" href="/aducid-resources/css/aducid.css" rel="stylesheet" />
   

Basic usage with AAA

Create instance of ADUCID object:

  var aducid = new ADUCID();

Set addresses of start, check and proxy operation of aducid-binder:

 aducid.setStartOperationUrl("/aducid-binder/open");
 aducid.setResultOperationUrl("/aducid-binder/openCheck");
 aducid.setProxyUrl("/aducid-binder/proxy");
      

Override default methods to customize you page:

 aducid.processResult = function(result) {
    if (result.status == "OK") {
       //authentication successful - reload page, redirect or display authenticated content
       location.reload();
    }
    else {
       //display error status from result.data.message
    }
 }

Text displayed before operation

 aducid.showQRHint = function(param) {
    $('#qr-code-hint').html("Example text - Use your PEIG to authenticate");
 }
 

Text displayed duringoperation

 aducid.showRunningHint = function(param) {
    $('#qr-code-hint').html("Example text - Operation in progress");
 }
 

Detailed description

integration-api/start.1530012498.txt.gz ยท Last modified: 2018/06/26 11:28 by tjotov