Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/regulaforensics/xamarin-documentreader
.NET MAUI (formerly Xamarin) Framework for reading and validation of identification documents
https://github.com/regulaforensics/xamarin-documentreader
Last synced: 1 day ago
JSON representation
.NET MAUI (formerly Xamarin) Framework for reading and validation of identification documents
- Host: GitHub
- URL: https://github.com/regulaforensics/xamarin-documentreader
- Owner: regulaforensics
- Created: 2018-06-20T15:01:01.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-25T11:25:41.000Z (2 months ago)
- Last Synced: 2024-10-29T22:46:16.628Z (2 months ago)
- Language: C#
- Homepage: https://regulaforensics.com
- Size: 1.32 MB
- Stars: 12
- Watchers: 7
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Xamarin - Regula Document Reader
MAUI:
copy regula.license to DocumentReaderSample/Resources/Raw/regula.license
copy db.dat to DocumentReaderSample/Platforms/Android/Assets/Regula/db.dat
and to DocumentReaderSample/Resources/Raw/db.dat
Regula Document Reader SDK allows you to read various kinds of identification documents, passports, driving licenses, ID cards, etc. All processing is performed completely ***offline*** on your device. No any data leaving your device.
You can use native camera to scan the documents or image from gallery for extract all data from it.
We have provided a simple application that demonstrates the ***API*** calls you can use to interact with the DocumentReader Library.
* [How to build demo application](#how_to_build_demo_application)
* [Troubleshooting license issues](#troubleshooting_license_issues)
## How to build demo application
1. Visit [client.regulaforensics.com](https://client.regulaforensics.com) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps.
1. Clone current repository using command `git clone https://github.com/regulaforensics/Xamarin-DocumentReader.git`.
1. Download and install latest [Visual Studio](https://visualstudio.microsoft.com/xamarin/) depend on your OS.
1. Copy file `regula.license` to `DocumentReaderSample/Droid/Assets` or `DocumentReaderSample/iOS/Resources` folder.
1. Copy file `db.dat` to `DocumentReaderSample/Droid/Assets/Regula` or `DocumentReaderSample/iOS/Resources` folder.
1. Launch _Visual Studio_ and select _File -> Open_ then select _DocumentReaderSample/DocumentReaderSample.sln_ file in file browser.
1. Download additional files proposed by _Visual Studio_ to build project (build tools, for example).
1. Select appropriate build variant and run application.
## Troubleshooting license issues
If you have issues with license verification when running the application, please verify that next is true:
1. OS you are using is the same as in the license you received (Android).
1. Date and time on the device you are trying to run the application is correct and inside the license validity period.
1. You are using the latest release of the SDK.
1. You placed the `license` into the correct folder as described here [How to build demo application](#how_to_build_demo_application) (`DocumentReaderSample/Droid/Assets` or `DocumentReaderSample/iOS/Resources` folder).
1. You placed the `db.dat` into the correct folder as described here [How to build demo application](#how_to_build_demo_application) (`DocumentReaderSample/Droid/Assets/Regula` or `DocumentReaderSample/iOS/Resources` folder).
# All available NuGet packages
You can find all available packages for Xamarin [here](https://www.nuget.org/profiles/regulaforensics).
# Getting Started - Android
* [How to add DocumentReader library to your project](#how_to_add_documentreader_library_to_your_project)
## How to add DocumentReader library to your project
To install the libraries for Android, simply open your project and install our NuGet packages named `Xamarin.DocumentReader.Api.Android` and (`Xamarin.DocumentReader.Core.Full.Android` or `Xamarin.DocumentReader.Core.FullRfid.Android`). For more details on how to install a NuGet package, [see here](https://blog.xamarin.com/xamarin-studio-and-nuget/).
Once the libraries are installed, see our [Document Reader Sample App](https://github.com/regulaforensics/Xamarin-DocumentReader/tree/master/DocumentReaderSample/Droid) for an example of how to use it.
# Getting Started - iOS
* [How to add DocumentReader library to your project](#how_to_add_documentreader_library_to_your_ios_project)
* [Initialization Core](#initialization_core)
* [Update Info.plist into your project](#update_info_plist)
* [Upload ipa to iTunes with SDK](#upload_ipa_to_itunes)
## How to add DocumentReader library to your project
To install the libraries for iOS, simply open your project and install our NuGet packages named `Xamarin.DocumentReader.Api.iOS` and `Xamarin.DocumentReader.Core.Full.iOS `. For more details on how to install a NuGet package, [see here](https://blog.xamarin.com/xamarin-studio-and-nuget/).
## Initialization Core
After you added libraries from NuGet to the project, make sure that you initialized `Core` int the code. For example, take a look int the code below.
```c#
public partial class ViewController : UIViewController
{
....
protected ViewController(IntPtr handle) : base(handle) =>
//WARNING!!!!
//Initialization DocumentReader from DocReaderCore is required
new DocReaderCore.iOS.DocumentReader();
....
}
```
FYI: Xamarin is not included into ipa frameworks which are not called in the code. You can successfylly build project and run, but in runtime you will get error that DocumentReaderCore library not loaded. See error below.
`dyld: Library not loaded: @rpath/DocumentReaderCore.framework/DocumentReaderCore`
## Update Info.plist into your project
Don't forgot update your plist with next properties:
* Privacy - Camera Usage Description
* Privacy - Photo Library Usage Description
It's required for make a snapshot from camera or get a photo from gallery.
## Upload ipa to iTunes with SDK
Because we're using Swift language for API SDK, cannot upload ipa to iTunes without next steps.
1. Archive your app for Publishing.
2. When the Archives window pops up, go to it in Finder (right click on it and select “Reveal in Finder”).
3. When Finder appears, we need to access the archive’s content (right click and select “Show Package Contents”).
4. Inside of the archive package, create a folder called “SwiftSupport”.
5. Inside of the package navigate to “Product/Applications/YourAppName.app/Frameworks” (You will need to right click on the .app and select “Show Package Contents”).
6. Now you should replace all “.dylib” files with files from this folder: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/iphoneos. Make sure you're not replaced all the swift “.dylib” files into Frameworks directory, because iTunes would reject build.
7. After that copy all the swift “.dylib” files inside of the Frameworks updated directory.
8. Navigate back to “SwiftSupport” and paste those copied libraries.
9. Now Launch Xcode and load Organizer (Window -> Organizer).
10. Find your app in the Archives and “Upload to App Store...“.
Once the libraries are installed, see our [Document Reader Sample App](https://github.com/regulaforensics/Xamarin-DocumentReader/tree/master/DocumentReaderSample/iOS) for an example of how to use it.