TIKI Capture Receipt (Capacitor Plugin)

The TIKI Capture Receipt Plugin for Capacitor enables the extraction of receipt data from email inboxes, and retailer accounts using Microblink's technology.

This plugin wraps (and simplifies) Microblink's native iOS and Android SDKs for use with Capacitor applications.

Learn more at 🍍 mytiki.com, or jump right into the 📘 API reference.

Installing

1. Install the dependency from NPM

npm install @mytiki/capture-receipt-capacitor

2. iOS only - Add Microblink iOS dependencies in ios/App/Podfile

source 'https://github.com/BlinkReceipt/PodSpecRepo.git' # <- add this
source 'https://cdn.cocoapods.org/' # <- add this

platform :ios, '13.0'

def capacitor_pods
  use_frameworks!
  pod 'Capacitor', :path => '../node_modules/@capacitor/ios'
  pod 'CapacitorCordova', :path => '../node_modules/@capacitor/ios'
end

target 'Plugin'do
  capacitor_pods
  use_frameworks!
  
  pod 'BlinkReceipt', '~> 1.27' # <- add this
  pod 'BlinkEReceipt', '~> 2.0' # <- add this
end


target 'PluginTests' do
  capacitor_pods
end

3. run npx cap sync

That's it. And yes, it's really that easy.

NOTE: if Cocoapods can't find BlinkReceipt/BlinkEReceipt in iOS, run pod install --repo-udpate and npx cap sync again.

Initialization

IMPORTANT: Requires a valid Microblink BlinkReceipt License Key and Product Intelligence Key. Reach out to get one →

import { instance } from '@mytiki/tiki-capture-receipt-capacitor'

instance.initialize('<PRODUCT KEY>', '<IOS LICENSE KEY>', '<ANDROID LICENSE KEY>', 
        .then((rsp) => console.log(`initialized`))

NOTE: Only iOS and Android are supported.

Contributing

• Use GitHub Issues to report any bugs you find or to request enhancements.
• If you'd like to get in touch with our team or other active contributors, pop in our 👾 Discord.
• Please use conventional commits if you intend to add code to this project.

Project Structure

• /src: The primary TS interface for the plugin.
• /android: The native Android implementation.
• /ios: The native iOS implementation.
• /example: A simple example project using the plugin

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!