This repository contains example wrapper for BlinkID native SDKs (iOS and Android). Not all features of native SDKs are available in PhoneGap wrapper. However, the wrapper is open source, so you can easily add features that you need. For 100% of features and maximum control, consider using native SDKs.
MicroBlink.framework/MicroBlink file in iOS submodule exceeds GitHubs limited file size of 100MB. To correctly init the submodule Git LFS is needed. Git LFS can be installed with homebrew:
brew install git-lfsAfter installation, don't forget to restart the terminal!
Downloading a repository just downloads the files from the most recent commit of the default branch but without all the dependencies which are in submodules. We recommend that you clone directory. With a clone option you will get a copy of the history and it’s functional git repository.
To clone repository:
- Copy URL from Clone or download button: https://github.com/BlinkID/blinkid-phonegap.git
- Open terminal on Mac/Linux or GitBash on Windows.
- cd into directory where you want the cloned directory to be made.
- Type
git clone, than past URL - Press enter
After cloning repository, make sure you clone also its submodules:
git submodule init
git submodule updateSample Cordova app is generated with a script
./initCordovaDemoApp.shTo run iOS demo application open Xcode project BlinkIdDemo.xcodeproj
To run Android demo application type
cordova run androidSample Ionic app is generated with a script
./initIonicDemoApp.shTo run iOS demo application open Xcode project BlinkIdDemo.xcodeproj
To run Android demo application type
ionic run android-
Generate a free demo license key to start using the SDK in your app (registration required)
-
Get information about pricing and licensing of BlinkID
First generate a empty project if needed:
cordova create <path> <package> <name>The shown instructions are for Cordova, the instructions for Ionic and PhoneGap are practically the same, except for some slight command line argument differences.
Add the BlinkID plugin to your project:
cd <path_to_your_project>
cordova plugin add <blinkID_plugin_path>Add Android platform support to the project:
cordova platform add android
Add iOS plaform support to the project:
cordova platform add ios
Here's a complete example of how to create and build a project for Android and iOS using cordova (you can substitute equivalent commands for phonegap):
# pull the plugin and sample application from Github
git clone https://github.com/BlinkID/blinkid-phonegap.git
# initialize and update submodules
git submodule init
git submodule update
# create a empty application
cordova create testcordova
cd testcordova
# add the blinkID plugin
cordova plugin add ../blinkid-phonegap/BlinkID
# add android support to the project
cordova platform add android
# build the project, the binary will appear in the bin/ folder
cordova build android
# add ios support to the project
cordova platform add ios
# build the project
cordova build iosIn phonegap CLI instead of "platform add" just request a build for the platform using "build android" or "build ios". You will have to do the manual steps described above to be able to do a successfull build.
You can also use provided initDemoApp.sh script that will generate a demo app that uses the plugin:
./initDemoApp.shTo run the script, you'll need BASH environment on Windows (Linux and MacOS use BASH by default).
To use the plugin you call it in your Javascript code like the demo application:
/**
* Use these scanner types
* Available: "PDF417", "USDL", "Bar Decoder", "Zxing", "MRTD", "UKDL", "MyKad"
* PDF417 - scans PDF417 barcodes
* USDL - scans barcodes located on the back of US driver's license
* Bar Decoder - scans code39 and code128 type barcodes. Both Code 39 and Code 128 are scanned by default when using Bar Decoder.
* Zxing - scans various types of codes (i.e. QR, Aztec). Types of scanned codes can be modified in plugin classes (Explained later in this readme). By default, scanned codes are set to: Code 39, Code 128, EAN 13, EAN 8, QR, UPCA, UPCE
* MRTD - scans Machine Readable Travel Document, contained in various IDs and passports
* UKDL - scans the front of United Kingom driver's license
* MyKad - scans the front of Malaysian ID cards
* Variable << types >> declared below has to contain all the scanners needed by your application. Applying additional scanners will slow down the scanning process
*/
var types = ["PDF417", "UKDL", "MRTD"];
/**
* Image type defines type of the image that will be returned in scan result (image is returned as Base64 encoded JPEG)
* available:
* "IMAGE_NONE" : do not return image in scan result
* "IMAGE_SUCCESSFUL_SCAN" : return full camera frame of successful scan
* "IMAGE_CROPPED" : return cropped document image (successful scan)
*
*/
var imageType = "IMAGE_CROPPED"
// Note that each platform requires its own license key
// This license key allows setting overlay views for this application ID: com.microblink.blinkid
var licenseiOs = "OLJJAUDF-CIV2HMG3-ZFEVNWIC-2FNSXP3W-YLKHF4MV-LTSI5GR7-I5ARBPXV-WRCTMCMT";
// This license is only valid for package name "com.microblink.blinkid"
var licenseAndroid = "NFRZVYWD-MCK7SSO7-TJ7ZWOC4-AT2AYDM7-JDHZQMHY-V3PZU4SX-54PGUFQM-AUX5RGYJ";
scanButton.addEventListener('click', function() {
cordova.plugins.blinkIdScanner.scan(
// Register the callback handler
function callback(scanningResult) {
// handle cancelled scanning
if (scanningResult.cancelled == true) {
resultDiv.innerHTML = "Cancelled!";
return;
}
// Obtain list of recognizer results
var resultList = scanningResult.resultList;
// Image is returned as Base64 encoded JPEG
var image = scanningResult.resultImage;
if (image) {
resultImg.src = "data:image/jpg;base64, " + image;
resultImgDiv.style.visibility = "visible"
} else {
resultImgDiv.style.visibility = "hidden"
}
// Iterate through all results
for (var i = 0; i < resultList.length; i++) {
// Get individual resilt
var recognizerResult = resultList[i];
if (recognizerResult.resultType == "Barcode result") {
// handle Barcode scanning result
var raw = "";
if (typeof(recognizerResult.raw) != "undefined" && recognizerResult.raw != null) {
raw = " (raw: " + hex2a(recognizerResult.raw) + ")";
}
resultDiv.innerHTML = "Data: " + recognizerResult.data + raw +
" (Type: " + recognizerResult.type + ")";
} else if (recognizerResult.resultType == "USDL result") {
// handle USDL parsing result
var fields = recognizerResult.fields;
resultDiv.innerHTML = /** Personal information */
"USDL version: " + fields[kPPStandardVersionNumber] + "; " +
"Family name: " + fields[kPPCustomerFamilyName] + "; " +
"First name: " + fields[kPPCustomerFirstName] + "; " +
"Date of birth: " + fields[kPPDateOfBirth] + "; " +
"Sex: " + fields[kPPSex] + "; " +
"Eye color: " + fields[kPPEyeColor] + "; " +
"Height: " + fields[kPPHeight] + "; " +
"Street: " + fields[kPPAddressStreet] + "; " +
"City: " + fields[kPPAddressCity] + "; " +
"Jurisdiction: " + fields[kPPAddressJurisdictionCode] + "; " +
"Postal code: " + fields[kPPAddressPostalCode] + "; " +
/** License information */
"Issue date: " + fields[kPPDocumentIssueDate] + "; " +
"Expiration date: " + fields[kPPDocumentExpirationDate] + "; " +
"Issuer ID: " + fields[kPPIssuerIdentificationNumber] + "; " +
"Jurisdiction version: " + fields[kPPJurisdictionVersionNumber] + "; " +
"Vehicle class: " + fields[kPPJurisdictionVehicleClass] + "; " +
"Restrictions: " + fields[kPPJurisdictionRestrictionCodes] + "; " +
"Endorsments: " + fields[kPPJurisdictionEndorsementCodes] + "; " +
"Customer ID: " + fields[kPPCustomerIdNumber] + "; ";
} else if (recognizerResult.resultType == "MRTD result") {
var fields = recognizerResult.fields;
resultDiv.innerHTML = /** Personal information */
"Family name: " + fields[kPPmrtdPrimaryId] + "; " +
"First name: " + fields[kPPmrtdSecondaryId] + "; " +
"Date of birth: " + fields[kPPmrtdBirthDate] + "; " +
"Sex: " + fields[kPPmrtdSex] + "; " +
"Nationality: " + fields[kPPmrtdNationality] + "; " +
"Date of Expiry: " + fields[kPPmrtdExpiry] + "; " +
"Document Code: " + fields[kPPmrtdDocCode] + "; " +
"Document Number: " + fields[kPPmrtdDocNumber] + "; " +
"Issuer: " + fields[kPPmrtdIssuer] + "; " +
"ID Type: " + fields[kPPmrtdDataType] + "; " +
"Opt1: " + fields[kPPmrtdOpt1] + "; " +
"Opt2: " + fields[kPPmrtdOpt2] + "; ";
} else if (recognizerResult.resultType == "UKDL result") {
var fields = recognizerResult.fields;
resultDiv.innerHTML = /** Personal information */
"ID Type: " + fields[kPPukdlDataType] + "; " +
"Date of Expiry: : " + fields[kPPukdlExpiry] + "; " +
"Issue Date: " + fields[kPPukdlIssueDate] + "; " +
"Driver Number: " + fields[kPPukdlDriverNumber] + "; " +
"Address: " + fields[kPPukdlAddress] + "; " +
"Birth Data: " + fields[kPPukdlBirthData] + "; " +
"First name: " + fields[kPPukdlFirstName] + "; " +
"Last name: " + fields[kPPukdlLastName] + "; ";
} else if (recognizerResult.resultType == "MyKad result") {
var fields = recognizerResult.fields;
resultDiv.innerHTML = /** Personal information */
"ID Type: " + fields[kPPmyKadDataType] + "; " +
"NRIC Number: " + fields[kPPmyKadNricNumber] + "; " +
"Address: " + fields[kPPmyKadAddress] + "; " +
"Birth Date: " + fields[kPPmyKadBirthDate] + "; " +
"Full Name: " + fields[kPPmyKadFullName] + "; " +
"Religion: " + fields[kPPmyKadReligion] + "; " +
"Sex: " + fields[kPPmyKadSex] + "; ";
}
}
},
// Register the error callback
function errorHandler(err) {
alert('Error: ' + err);
},
types, imageType, licenseiOs, licenseAndroid
);
});-
Available scanners are:
- PDF417 - scans PDF417 barcodes
- USDL - scans barcodes located on the back of US driver's license
- Bar Decoder - scans code39 and code128 type barcodes. Both Code 39 and Code 128 are scanned by default when using Bar Decoder.
- Zxing - scans various types of codes (i.e. QR, Aztec). Types of scanned codes can be modified in plugin classes (Explained later in this readme). By default, scanned codes are set to: Code 39, Code 128, EAN 13, EAN 8, QR, UPCA, UPCE
- MRTD - scans Machine Readable Travel Document, contained in various IDs and passports
- UKDL - scans the front of United Kingom driver's license
- MyKad - scans the front of Malaysian ID cards
-
On returned result, image can also be returned (under "resultImage" field) as base64 string of JPEG image. Type of returned image is specified as second argument and can be:
- "IMAGE_NONE" - No image will be returned
- "IMAGE_SUCCESSFUL_SCAN" - Whole input image which returned the result.
- "IMAGE_CROPPED" - Cropped and dewarped image of scanned object. For example, ID recognizers will return cropped and dewarped image of ID
-
All license parameters must be provided (for iOS and Android) even if you do not plan to run the application on both platforms. The licenses that you do not have/use must be set to
null.
To change scanner settings you need to modify Phonegap plugin classes for iOS and Android. Plugin classes are located in ./BlinkID/src . All necessary settings documentation is located in those source files.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent