Differences

This shows you the differences between two versions of the page.

Link to this comparison view

mobile-integration:android [2019/08/01 10:03] (current)
tjotov created
Line 1: Line 1:
 +====== Developing Android application with ADUCID ======
 +ADUCID PEIG API provides simple way how to integrate ADUCID to custom client application. To keep session cookies, PEIG API uses http async client. (getAsyncClient())
 +
 +===== Creating authentication request =====
 +
 +1) First create an instance of PEIG API \\ (only one per application object / set of requests)
 +<code java>
 +com.aducid.peig.api.Papi papi = new com.aducid.peig.api.Papi(android.content.Context ctx)
 +com.aducid.peig.lib2.PeigAPI peigApi = new com.aducid.peig.lib2.PeigAPI(android.content.Context ctx)
 +</​code>​
 +
 +or create DummyApplication ​   ​
 +
 +<code java>
 +public class DummyApplication extends com.aducid.peig.lib2.PeigAPILibApplication {
 +    protected com.aducid.peig.api.Papi papi;
 +    protected com.aducid.peig.lib2.PeigAPI peigApi;
 +    ​
 +    public DummyApplication() {
 +       ​peigApi = getPeigAPI();​
 +       papi = getPapi();
 +    }
 +
 +...
 +}
 +</​code>​
 +
 +2) Prepare a handler which is going to be called when PEIG API is finished (see below)
 +
 +3) Call PEIG API method aducidAuthentication ():
 +
 +<code java>
 +peigApi.aducidAuthentication(java.lang.String url, android.os.Handler handler)
 +</​code>​
 +
 +  * **url** ​ is address of your **application** ​ including protocol, e.g. [[https://​demobank.aducid.com/​demobank|https://​demobank.aducid.com/​demobank]]
 +  * **handler** ​ is code that is called to evaluate authentication
 +
 +4) In your Handler override **handleMessage** ​ (Message msg) and get the result:
 +
 +<code java>
 +com.aducid.peig.lib2.Result result = msg.getData().getParcelable("​result"​);​
 +</​code>​
 +
 +then evaluate it - see [[developers:​peig-api:​android#​responses|Responses]]
 +
 +===== Responses =====
 +
 +Your code should evaluate these possible outcomes:
 +
 +I.
 +
 +<code java>
 +if result.isOK()
 +</​code>​
 +
 +Your session is authenticated
 +
 +In DemoBank, result.gerRedirect() contains link to page with account data. Method result.containsRedirectUri() returns //true//, if redirect contains some link.
 +
 +II.
 +
 +<code java>
 +else if (result.peigNotInstalled())
 +</​code>​
 +
 +PEIG is not installed. To fix it, you can display a dialog and then open GooglePlay to install it:
 +
 +<​code>​
 +papi.installPEIG(getActivity());​
 +</​code>​
 +
 +III.
 +
 +<code java>
 +else if (result.isNetworkError())
 +</​code>​
 +
 +Communication error occurred – either phone has no connectivity or destination cannot be reached (wrong URL or server is not running).
 +
 +IV.
 +
 +<code java>
 +else {other exception / redirect / state}
 +</​code>​
 +
 +Custom application errors, authentication failed!
 +
 +  * result.getException() contains ADUCID exception, there are possible states:
 +      * result.notAcceptedByUser():​ user rejected
 +      * result.isFactorAbsent():​ user doesn’t have personal factor (and server requires it)
 +  * result.getData() contains error message / reason
 +  * result.getRedirect() contains page that could be opened using browser / contains additional content to download/ display to the user.
 +
 +//See com.aducid.peig.lib2.Result class for all details//
 +
 +===== Retrieve data when authenticated =====
 +
 +In case I. your result is “OK” and your mobile application is authenticated. Use this session to contact your application server. AsyncHttpClient is used as http client to keep session cookies and GET/​POST/​PUT/​DELETE operations. Following example shows how to use this client to GET a page when authenticated:​
 +
 +<​code>​
 +peigApi.aducidContent(java.lang.String url, java.lang.String methodName, android.os.Handler handler)
 +</​code>​
 +
 +  * **url** ​ – target page / method URL, e.g. [[https://​demobank.aducid.com/​demobank|https://​demobank.aducid.com/​demobank]]
 +  * **methodName** - method path, e.g. /​accountRemote
 +  * **handler** ​ – Android callback to be executed when data is loaded
 +==== Try to get data if not authenticated ====
 +
 +To check your setup, test if you get error response from the server
 +
 +===== Advanced requests =====
 +
 +To accomplish a specific action like transaction use aducidFullOperationGet() or aducidFullOperationPost().
 +
 +
 +<code java>
 +peigApi.aducidFullOperationPost(String url, String methodName, com.loopj.android.http.RequestParams parameters, android.os.Handler handler)
 +</​code>​
 +
 +  * **url** ​ is address of your **application** ​ including protocol, e.g. [[https://​demobank.aducid.com/​demobank|https://​demobank.aducid.com/​demobank]]
 +  * **methodName** ​ is path to required page / method (e.g. “/​remotePayment”)
 +  * **parameters** ​ are set of parameters which will be sent to the server, null if there is no parameter
 +  * **handler** ​ – see above – your callback after ADUCID is done
 +Get the result:
 +
 +<code java>
 +Handler handler = new Handler() {
 +                    @Override
 +                    public void handleMessage(Message msg) {
 +                     
 +                        if (msg.getData() != null) {
 +                            com.aducid.peig.lib2.Result result = msg.getData().getParcelable("​result"​);​
 +                            // do something with result
 +                        }
 +                    }
 +                }
 +</​code>​
 +
 +And parse it – see [[developers:​peig-api:​android#​responses|Responses]]
 +
  
  • mobile-integration/android.txt
  • Last modified: 2019/08/01 10:03
  • by tjotov