Differences

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

--- web-integration:c-sharp-example [2019/08/01 10:25]
tjotov created
+++ web-integration:c-sharp-example [2019/08/05 11:27] (current)
tjotov
@@ Line 1: / Line 1: @@
 ====== C# Example ======
-C# relies on Web services for ADUCID - or WSA.
+C# relies on Web services for ADUCID - or WSA, see [[web-integration:basics|Server side integration basics]]
-Web service is a standalone “application” which must be deployed on same server as AIM. Its default address is like this:
-<code>
+Import WSDL into your project in Visual Studio.
-https://hostname/wsa-json
-</code>
-There you will see WSA Interface homepage where you can download WSDL file to generate client.
-<code>
-https://hostname/wsa-json?wsdl
-</code>
-For detailed methods / classes / types description see [[http://wiki.aducid.com/client-api|Javadoc SDK Client API]]
-=== Import WSDL into your project in Visual Studio. ===
 Create an instance of **AducidApiJsonServiceClient**.
@@ Line 24: / Line 10: @@
 <sxh csharp>
-var aducid = new AducidApiJsonServiceClient();
+            System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12;
-string host = "http://" + HttpContext.Current.Request.Url.Host + ":" + HttpContext.Current.Request.Url.Port;
+            context.Response.ContentType = "application/json";
-string query = context.Request.QueryString.ToString();
-var queryParsed = HttpUtility.ParseQueryString(query);
-var generateQr = queryParsed["generateQrCodePicture"];
-var arg = new OperationArgument();
-//return URL for iOS
-arg.peigReturnName = host + "/result";
-//QR code picture size
-arg.qrCodePictureHeight = 300;
-arg.qrCodePictureWidth = 300;
-//tab helper If - if more authentication are in web browser in more tabs this help ti identify them - has to be unique
-arg.id = "123";
-arg.generateQrCodePicture = generateQr == "true";
-//JSON response from WSA
+            var aducid = new AducidApiServiceClient();
-var response = aducid.startAuthenticationSession(JsonConvert.SerializeObject(arg));
+            //get current URI
-//parse and store authId
+            string host = "http://" + HttpContext.Current.Request.Url.Host + ":" + HttpContext.Current.Request.Url.Port;
-dynamic responseObj = JsonConvert.DeserializeObject(response);
+            string query = context.Request.QueryString.ToString();
-//store authId in your session
+            var queryParsed = HttpUtility.ParseQueryString(query);
-context.Session["123"] = (string) responseObj.data.authId;
+            //should we display QR?
-context.Response.ContentType = "text/plain";
+            var generateQr = queryParsed["generateQrCodePicture"];
-//send response
-context.Response.Write(response);
-</sxh>
-OperationArgument is a simple object
+            //create argument
-<sxh csharp>
+            var arg = new requestOperationArguments();
-public class OperationArgument
+            //final URL for iOS
-    {
+            arg.peigReturnName = host + "/authenticated";
-        public String peigReturnName { get; set; }
+            arg.qrCodePictureHeight = 300;
-        public int qrCodePictureHeight { get; set; }
+            arg.qrCodePictureWidth = 300;
-        public int qrCodePictureWidth { get; set; }
+            //ID to support multiple authentications in the same browser
-        public String id { get; set; }
+            arg.id = Guid.NewGuid().ToString();
-        public Boolean generateQrCodePicture { get; set; }
+            arg.generateQrCodePicture = generateQr == "true";
-    }
+            try
+            {
+                //inititialize authentication and get response
+                var response = aducid.startAuthenticationSession(arg);
+                //store authId in session - security
+                context.Session[arg.id] = response.authId;
+                context.Response.ContentType = "application/json";
+                //send repsponse to Web API
+                context.Response.Write(aducid.toJson(response, ""));
+            }
+            catch (System.ServiceModel.FaultException e)
+            {
+                //handle error
+                var msgFault = e.CreateMessageFault();
+                var errorResult = msgFault.GetDetail<AducidClientException>().result;
+                //get error as JSON
+                var response = aducid.toErrorJson(errorResult, "error");
+                //send JSON to Web API
+                context.Response.Write(response);
+            }
 </sxh>
 === Create WSA proxy ===
 Just simple "Rewrite" from WSA to C# with authId check
 <sxh csharp>
-var aducid = new AducidApiJsonServiceClient();
+            //We have to "proxy" AIM reponses to Web APIuising this page
-string host = "http://" + HttpContext.Current.Request.Url.Host + ":" + HttpContext.Current.Request.Url.Port;
+            var aducid = new AducidApiServiceClient();
-var response = aducid.getStatus((string)context.Session["123"]);
+            context.Response.ContentType = "application/json";
-context.Response.ContentType = "text/plain";
+            try
-context.Response.Write(response);
+            {
+                string query = context.Request.QueryString.ToString();
+                var queryParsed = HttpUtility.ParseQueryString(query);
+                //get id from session based on GUID
+                var id = queryParsed["id"];
+                //get response from AIM
+                var response = aducid.getStatus((string)context.Session[id]);
+                //send response to Web API
+                context.Response.Write(aducid.toJson(response, ""));
+            }
+            catch (System.ServiceModel.FaultException e)
+            {
+                //handle error
+                var msgFault = e.CreateMessageFault();
+                var errorResult = msgFault.GetDetail<AducidClientException>().result;
+                //get error as JSON
+                var response = aducid.toErrorJson(errorResult, "error");
+                //send JSON to Web API
+                context.Response.Write(response);
+            }
 </sxh>
@@ Line 76: / Line 89: @@
 <sxh csharp>
-var aducid = new AducidApiJsonServiceClient();
+            var aducid = new AducidApiServiceClient();
-//read authId from you session
+            string query = context.Request.QueryString.ToString();
-string authId = (string)context.Session["123"];
+            var queryParsed = HttpUtility.ParseQueryString(query);
-var aducidResult = aducid.getResult(authId, null);
+            var id = queryParsed["id"];
-//parse json
+            //get authId from session
-dynamic aducidResultObj = JsonConvert.DeserializeObject(aducidResult);
+            string authId = (string)context.Session[id];
-//User primary key i.e. UDI
+            context.Response.ContentType = "application/json";
-var udi = aducidResultObj.data.userDatabaseIndex;
+            try
-//key to further ADUCID operetions on user object (with authId)
+            {
-string authKey2 = aducidResultObj.data.authKey2;
+                //call AIM to get operation result
-//prepare response
+                var aducidResult = aducid.getResult(authId, null);
-var response = aducid.endAuthenticationSession(authId, authKey2);
+                //User Database Index, i.e. UDI
-context.Response.ContentType = "text/plain";
+                var udi = aducidResult.userDatabaseIndex;
-//OK do something with your session
+                //authKey (with authId) used to access user data later from AIM
-//...
+                var authKey2 = aducidResult.authKey;
-//send response
+                //finalize authentication and get respoonse form Web API
-context.Response.Write(response);
+                var response = aducid.endAuthenticationSession(authId, authKey2);
+                //AUTHENTICATED
+                FormsAuthentication.SetAuthCookie("auth", false);
+                //send Web API the result - by default it will redirect to URI we provided earlier; for iOS PEIG opens this URI directly
+                context.Response.Write(aducid.toJson(response, "authenticated"));
+            }
+            catch (System.ServiceModel.FaultException e)
+            {
+                //handle error
+                var msgFault = e.CreateMessageFault();
+                var errorResult = msgFault.GetDetail<AducidClientException>().result;
+                //get error as JSON
+                var response = aducid.toErrorJson(errorResult, "error");
+                //send JSON to Web API
+                context.Response.Write(response);
+            }
 </sxh>
 === Prepare a web page ===
-This page should contain [[integration-api:start|ADUCID Integration API]]\\
+This page should contain [[web-integration:client-side|Client API for Web Integration]]\\
 Provide start, check and proxy Url.
-<sxh>
-   aducid.setStartOperationUrl("open");
-   aducid.setResultOperationUrl("openCheck");
-   aducid.setProxyUrl("proxy");
-</sxh>
 Override what should be done after authentication / operation:
-<sxh>
+<sxh javascript>
-   aducid.processResult = function (result) {
+     <script type="text/javascript">
+        var aducid = new ADUCID();
+        $(document).ready(function () {
+            aducid.setAuthentication();
+            //operation start URL
+            aducid.setStartOperationUrl("open");
+            //operation check URL
+            aducid.setResultOperationUrl("openCheck");
+            //proxy helper URL
+            aducid.setProxyUrl("proxy");
+            //text under QR code
+            aducid.showQRHint = function (param) {
+                $('#qr-code-hint').html("Use your PEIG to authenticate");
+            }
+            //running operation texr
+            aducid.showRunningHint = function (param) {
+                $('#qr-code-hint').html("Please wait ...");
+            }
+            //called when auth finished (except iOS)
+            aducid.processResult = function (result) {
+                alert("Auth finished. Result: " + JSON.stringify(result));
                 if (result.status == "OK") {
-                    alert("atuhenticated");
+                    location.href = result.redirect;
-                    //location.reload();
                 }
                 else {
-                    alert("atuhentication failure");
+                    location.href = result.redirect;
                 }
             }
+            //handle PEIG not installed error
+            aducid.showPeigError = function () {
+                showDialog("Problem with PEIG", "PEIG is not installed", "error", function () {
+                    location.reload();
+                });
+            }
+            //handle communication or other error
+            aducid.handleError = function (result) {
+                showDialog("General error", result.data.message, "error", function () {
+                    location.href = result.redirect;
+                });
+            }
+            //GUI mapping
+            //button associated to start auth
+            aducid.setButton($("#main-button"));
+            //locatino of QR code img
+            aducid.setQrCode($("#qr-code"));
+            //location of text under QR code
+            aducid.setQrHint($("#qr-code-hint"));
+            //start; false as we wait for button click or qr scan
+            aducid.init(false);
+        });
+    </script>
 </sxh>
@@ Line 120: / Line 193: @@
 <sxh html>
-<h1>ADUCID Hello World example</h1>
+    <div class="container">
+        <h1>ADUCID Hello World example</h1>
         <div class="row">
             <div class="col-xs-8 col-xs-offset-2">
@@ Line 146: / Line 220: @@
             </div>
         </div>
+    </div>
 </sxh>

ADUCID 4.x

User Tools

Site Tools

Differences

Page Tools