You are on page 1of 4

Aadhaar Hackathon Developer Guide

Overview
Contents
SDK
AndroidSDK
NonAndroidSDK
ClientAPIDocumentation
GatewayAPIDocumentation
GatewayURL
Samples
AndroidApplication(AadhaarAuthenticatorAndroidSample)
StandaloneApplication(AadhaarPacketCreatorStandaloneSample)
Faqs

Overview

Thedocumentationdetailsoutthecontentofthekitprovidedforhackathonparticipantsalong
withfaqstohelpandacceleratetheappdevelopmentduringthehackathonevent.

Contents
Thehackathonkitcontainsthefollowingartifacts
AadhaarBridgeClientAPIDocumentation
AadhaarBridgeGatewayDocumentation
AndroidSDKApp
StandaloneSDKforAuth/KYCPacketCreation(fornonandroidplatforms)
GatewayURL
Samples

CopyrightKhoslaLabsPvtLtd.StrictlyonlyforAadhaarHackathonparticipants.

SDK

ThekitprovidestwoSDKforthepurposeofintegratingwithanAndroidapplicationaswellas
othernonandroidplatform.TheSDKlibraryisprimarilyavailableonlyonJavaplatform.

Android SDK
AndroidAppSDKisaandroidapplication,whichneedstobeinstalledontheAndroidPhone
withOTGsupport.Theappsupportsthe
MorphoMSO1300FingerprintDevice
,whichis
usedaspartofthishackathonevent.TheintegrationwiththeapplicationisthroughAndroid
INTENTS.Thedocumentationisavailableinthe
ClientAPIDocumentationSection
.

Lookatthesampleandroidapplicationforusage.

Non-Android SDK
FornonandroidapplicationaJavalibraryhasbeenprovided,whichcanbeincludedasa
mavenorasalibdependency.Toinstallasamavenartifactpleaseusethescriptprovidedas
partofthefolder(forsampleapplicationitisincludedasalocalrepo).

Pleasenotethatthelibraryincludethefollowingcomponents
ClientAPIPOJOs
Aadhaarprotobufschema(googleprotobuf)
UIDAIPubliccertificates

Lookatthesampleforusageandcodedocumentation.

Client API Documentation


TheclientSDKdocumentationcanfoundonthefollowinglinkwithcodesnippets.
http://bridge.aadhaarconnect.com/clientsdk.html

Gateway API Documentation


ThegatewaySDKdocumentationcanfoundonthefollowinglinkwithcodesnippets.
http://bridge.aadhaarconnect.com/gatewaysdk.html

CopyrightKhoslaLabsPvtLtd.StrictlyonlyforAadhaarHackathonparticipants.

Gateway URL
AllrequestsarerequiredtobesubmittedtothefollowingURLswithContentTypeas

application/json

API

EndpointURL

Auth

https://ac.khoslalabs.com/hackgate/hackathon/auth

OTP

https://ac.khoslalabs.com/hackgate/hackathon/otp

Kyc

https://ac.khoslalabs.com/hackgate/hackathon/kyc

Samples
Thehackathonkitprovidesfollowingsampleapplications

Android Application (AadhaarAuthenticatorAndroidSample)

ThisapplicationacceptstheaadhaarnumberfromtheuserandinvokestheAadhaarBridge
SDKapptocapturethebiometrics,whichinturnreturnstheAadhaarcompliantpacketasa
JSONstructure,whichisthensubmittedtothehackathongatewayAuthAPIforfurther
processing.

Standalone Application (AadhaarPacketCreatorStandaloneSample)

Fornonandroidapplications(desktops,webapp),thekitprovidesaJavalibrarythatcreatesa
Aadhaarcompliantpacket,whichthencanbesubmittedtothehackathongatewayfor
Auth/KYC.ThecodeincludesasamplemethodsforbuildingAuthenticationandKYC
Packets.Thesampleisamavenproject,henceuseEclipseandimportit(existingmaven
project).

CopyrightKhoslaLabsPvtLtd.StrictlyonlyforAadhaarHackathonparticipants.

Faqs

Q.WhatarethestepstocapturethefingerprintoncetheSDKisintegratedwiththe
Androidapp?

A.AfterinvokingtheINTENTontheAadhaarBridgeAndroidApplicationforcapturingthe
fingerprint,theappwillshowthescreenwith6fingers.
Selectthefingerposition,whichtheuserwantstoscanbytappingonthecircle.
Completionofthepreviousstep(dependingonthenumberoffingersparameter),user
placestheindicatedfingeronthescannerforbiometriccapture.
SuccessfulcaptureturnsthecircletogreenandallcaptureswillmakethePROCEED
buttonenabled.
TaponthePROCEEDbuttonforcompletetheprocess(thisstepwillreturnthe
AuthCaptureDataJSONdata).
NOTE:Makesurethatthefingerprintsensorisconnectedtothephone.

Q.IsthereanyspecialconsiderationwhileprocessingJSONRequest/Response?
A.Yes.Anyrequest/responsecontainingbyte[]datarequiresaspecialcare.Forthisreasona
utilityclass
com.khoslalabs.util.GsonSerializerUtil
isavailableaspartofthesample
applications.
GsonSerializerUtil
forandroidandstandaloneapplicationsaredifferentas
theyusedifferentlibraryforbase64encoding/decoding.Hencepicktherightclassbasedon
applicationplatform.

Q.HowtocheckwhethermyAndroidphonesupportsOTGornot.
A.ConnectthefingerprintsensortothephoneusingtheOTGcable.Thelightonthesensor
shouldglow.Ifitdoesnotglowthensensorwillnotwork.Additionallyyoucancheckthe
phonespecificationforOTGsupport.

CopyrightKhoslaLabsPvtLtd.StrictlyonlyforAadhaarHackathonparticipants.