Interested in adding Card Reading functionality into a new or existing iOS application? Look no further.
Open Business Card Reader for iOS is an open source example implementation of FullContact Card Reader. It's built on top of our fullcontact-objc library and shows how to caputure business card images, send them to the FullContact Card Reader API, and receive transcribed Contact information back to your device.
Once you clone the Open Business Card Reader Source locally, you'll need to get a FullContact API key to get up and running. You'll also need to ensure you are using XCode 5.
###Obtain a FullContact API Key
A FullContact API key can be obtained on our Developer Portal.
###Insert your FullContact API Key
After obtaining a FullContact API Key, search for FCCardReaderHelper.m inside the Code\Helpers folder. Add your key to the following line:
NSString *const kAPIKey = nil; //TODO: Enter your API key here
For example:
NSString *const kAPIKey = @"MYAPIKEY";
###Set your webhook url (in FCCardReaderHelper.m)
You can see the we have the default set to http://requestb.in. Create a request bin for testing if you need to.
#define kMyServiceWebHook @"http://requestb.in" //TODO: Enter your Webhook Url here
* This webhook is where finished data is sent.
* When the webhook sends, handle it appropriately. See [CardReader API Docs](https://www.fullcontact.com/developer/docs/card-reader/) for more info about webhooks.
* The simplest thing to do with the webhook is trigger a push notification to the device.
* When this notification is received, the phone can poll the updated contact data.
###Update Submodule Dependencies Update the codebase and pull in the submodule dependencies by issuing the following command in the folder you have cloned the repository into:
git submodule update --init --recursive
Depending on your application architecture and requirements there are different methods for integrating Open Business Card Reader into your application.
Check out the Wiki for more information.
Open Business Card Reader requires iOS 7.0 or above.
This project uses ARC.
If you are using Open Business Card Reader in your non-arc project, you will need to set a -fobjc-arc compiler flag on all of the source files.
To set a compiler flag in Xcode, go to your active target and select the "Build Phases" tab. Now select all Open Buisness Card Reader source files, press Enter, insert -fobjc-arc and then "Done" to enable ARC.
##Need Help - No Problem! We're always available to help in any way we can. Check out our Support Page to access our Knowledge Base or contact our Support group.
##Got an Idea? We love ideas! Submit your ideas, suggestions, or feedback on our API Developer Forum or fork our repo. We review pull requests regularly and look forward to seeing what you come up with!
Open Business Card Reader for iOS is available under the Apache License Version 2.0 license. See the LICENSE file for more info.