User Tools

Site Tools


integration-api:detailed

This is an old revision of the document!


ADUCID Integration API Description

advanced method to pass more parameters like transaction amount, description, etc.

  aducid.setInitParams = function(param) {
      initParams = param;
  }

tell server to generate QR / or not to reduce payload

  aducid.setGenerateQr = function(param) {
      generateQr = param;
  }

QR code and animation location jQuery

  aducid.setQrCode = function(param) {
      qrCode = param;
  }
  

QR code hint jQuery

  aducid.setQrHint = function(param) {
      qrHint = param;
  }

Embedded timer location

  aducid.setQrTimer = function(param) {
      qrTimer = param;
  }

debug DOM to display internal messages

  aducid.setDebug = function(param) {
      aducidDebug = param;
  }

server URL typically provided by server side controller

  aducid.setStartOperationUrl = function(param) {
      startOperationUrl = param;
  }

check method location provided by server side controller

  aducid.setResultOperationUrl = function(param) {
      resultOperationUrl = param;
  }
  //URL with proxy method provided  by server
  //returns status oft running operation from AIM until finish
  aducid.setProxyUrl = function(param) {
      proxyUrl = param;
  }

Tell AJAX to use GET or POST POST is used to deliver more data like transaction parameters

  aducid.setAjaxMethod = function(param) {
      ajaxMethod = param;
  }

Redirect URL for iOS typically provided by server side controler

  aducid.setRedirectUrl = function(param) {
      redirectUrl = param;
  }

Button with bound operation

  aducid.setButton = function(param) {
      aducidButton = param;
      param.click(function() {
          if (currentRequest != null) instance.startOperation();
          else instance.init(true);
      });
  }

Internal logic to evaluate API binding mode

  aducid.setSessionBinding = function(param) {
      if (param == "QR" || param == "URI") {
      }
      else param = "";
      localStorage['session-binding'] = param;
  }

Get last binding mode

  aducid.getSessionBinding = function() {
      return localStorage['session-binding'];
  }

Is binding URI?

  aducid.isURI = function() {
      return instance.getSessionBinding() == "URI";
  }
  

Is binding QR?

  aducid.isQR = function() {
      return instance.getSessionBinding() == "QR";
  }

Is this operation going to be authentication (i.e. first operation in chain)?

  aducid.setAuthentication = function() {
      instance.setSessionBinding(null);
  }

Text hint shown before operation started

  aducid.showQRHint = function(param) {
      if (qrHint != null) qrHint.html(localize("aducid_common_authenticateComment"));
  }

How API can hide text hint

  aducid.hideQRHint = function(param) {
      if (qrHint != null) qrHint.html("");
  }

Text hint shown after operation started

  aducid.showRunningHint = function(param) {
      if (qrHint != null) qrHint.html(localize("aducid_common_authenticationProgress"));
  }

How API can hide text hint

  aducid.hideRunningHint = function(param) {
      if (qrHint != null) qrHint.html("");
  }
integration-api/detailed.1530006527.txt.gz ยท Last modified: 2018/06/26 09:48 by tjotov