This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
web-integration:client-side [2019/08/05 12:04] tjotov [Advanced usage] |
web-integration:client-side [2020/02/29 10:53] (current) mpospisek [Web Integration API - Example] |
||
---|---|---|---|
Line 52: | Line 52: | ||
===== Web Integration API - Example ===== | ===== Web Integration API - Example ===== | ||
- | <code html> | + | <sxh html> |
<html xmlns=" | <html xmlns=" | ||
Line 122: | Line 122: | ||
</ | </ | ||
- | </code> | + | </sxh> |
- | ===== Advanced usage ===== | + | ===== Detailed description |
See also source file "/ | See also source file "/ | ||
+ | ==== Communication ==== | ||
=== Start operation URL === | === Start operation URL === | ||
Tell Web API where your start operation is. | Tell Web API where your start operation is. | ||
Line 152: | Line 153: | ||
</ | </ | ||
- | + | === Tell AJAX to use GET or POST === | |
- | === Tell server | + | POST is used to deliver more data like transaction parameters |
<sxh java> | <sxh java> | ||
- | aducid.setGenerateQr | + | aducid.setAjaxMethod |
- | | + | |
} | } | ||
</ | </ | ||
- | === QR code targeting using jQuery | + | === Redirect URL set by GUI === |
+ | This is usuallly set by server side but can be also managed from client side. Server side has higher priority. | ||
<sxh java> | <sxh java> | ||
- | aducid.setQrCode | + | aducid.setRedirectUrl |
- | | + | |
} | } | ||
</ | </ | ||
- | === QR code text hint jQuery | + | === Error redirect URL set by GUI === |
+ | This is usuallly set by server side but can be also managed from client side. Server side has higher priority. | ||
<sxh java> | <sxh java> | ||
- | aducid.setQrHint | + | aducid.setErrorPage |
- | | + | |
} | } | ||
</ | </ | ||
- | + | === Final action | |
- | === Init Params | + | What API should do when operation finishes (not processed on iOS as we use returnUrl directly there) |
- | Method to pass more parameters like transaction amount, description, | + | |
<sxh java> | <sxh java> | ||
- | aducid.setInitParams | + | aducid.processResult |
- | | + | |
} | } | ||
</ | </ | ||
- | === Debug DOM to display internal messages | + | === Use push === |
+ | Tell Web API if it should use push (QR code was used previously). | ||
<sxh java> | <sxh java> | ||
- | aducid.setDebug | + | |
- | | + | push = param == true; |
+ | } | ||
+ | </ | ||
+ | ==== UI methods ==== | ||
+ | === Tell server to generate QR / or not to reduce payload === | ||
+ | <sxh java> | ||
+ | | ||
+ | | ||
} | } | ||
</ | </ | ||
- | + | === QR code targeting using jQuery | |
- | === Tell AJAX to use GET or POST === | + | |
- | POST is used to deliver more data like transaction parameters | + | |
<sxh java> | <sxh java> | ||
- | aducid.setAjaxMethod | + | aducid.setQrCode |
- | | + | |
} | } | ||
</ | </ | ||
- | === Redirect URL for iOS typically provided by server side controler | + | === QR code text hint jQuery |
<sxh java> | <sxh java> | ||
- | aducid.setRedirectUrl | + | aducid.setQrHint |
- | | + | |
} | } | ||
</ | </ | ||
Line 216: | Line 224: | ||
} | } | ||
</ | </ | ||
- | |||
- | |||
- | === Get last binding mode === | ||
- | <sxh java> | ||
- | aducid.getSessionBinding = function() { | ||
- | return localStorage[' | ||
- | } | ||
- | </ | ||
- | |||
- | === Is binding URI? === | ||
- | <sxh java> | ||
- | aducid.isURI = function() { | ||
- | return instance.getSessionBinding() == " | ||
- | } | ||
- | </ | ||
- | | ||
- | === Is binding QR? === | ||
- | <sxh java> | ||
- | aducid.isQR = function() { | ||
- | return instance.getSessionBinding() == " | ||
- | } | ||
- | |||
- | === Is this operation going to be authentication (i.e. first operation in chain)? === | ||
- | <sxh java> | ||
- | aducid.setAuthentication = function() { | ||
- | instance.setSessionBinding(null); | ||
- | } | ||
- | </ | ||
- | |||
=== Text hint shown before operation started === | === Text hint shown before operation started === | ||
<sxh java> | <sxh java> | ||
Line 271: | Line 250: | ||
} | } | ||
</ | </ | ||
- | |||
- | === The most important method === | ||
- | What API should do when operation finishes (not processed on iOS as we use returnUrl directly there) | ||
- | <sxh java> | ||
- | aducid.processResult = function(result) { | ||
- | alert(result); | ||
- | } | ||
- | </ | ||
- | |||
- | === How PEIG not installed is treated, marketplace redirect can be used here === | ||
- | <sxh java> | ||
- | aducid.showPeigError = function() { | ||
- | alert(" | ||
- | } | ||
- | </ | ||
- | |||
=== Auxiliary method to animate operation in progress === | === Auxiliary method to animate operation in progress === | ||
<sxh java> | <sxh java> | ||
Line 302: | Line 265: | ||
if (qrCode == null) return; | if (qrCode == null) return; | ||
qrCode.hide(); | qrCode.hide(); | ||
+ | } | ||
+ | </ | ||
+ | ==== Advanced methods ==== | ||
+ | === Init Params === | ||
+ | Method to pass more parameters like transaction amount, description, | ||
+ | <sxh java> | ||
+ | aducid.setInitParams = function(param) { | ||
+ | initParams = param; | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | === Debug DOM to display internal messages === | ||
+ | <sxh java> | ||
+ | aducid.setDebug = function(param) { | ||
+ | aducidDebug = param; | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | === Is binding URI? === | ||
+ | <sxh java> | ||
+ | aducid.isURI = function() { | ||
+ | return instance.getSessionBinding() == " | ||
+ | } | ||
+ | </ | ||
+ | | ||
+ | === Is binding QR? === | ||
+ | <sxh java> | ||
+ | aducid.isQR = function() { | ||
+ | return instance.getSessionBinding() == " | ||
+ | } | ||
+ | |||
+ | === Is this operation going to be authentication (i.e. first operation in chain)? === | ||
+ | <sxh java> | ||
+ | aducid.setAuthentication = function() { | ||
+ | instance.setSessionBinding(null); | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | === Get last binding mode === | ||
+ | <sxh java> | ||
+ | aducid.getSessionBinding = function() { | ||
+ | return localStorage[' | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | === How PEIG not installed is treated, marketplace redirect can be used here === | ||
+ | <sxh java> | ||
+ | aducid.showPeigError = function() { | ||
+ | alert(" | ||
} | } | ||
</ | </ |