NHN Cloud Credit Card RecognizerはAndroid 5.1以上(API level 22以上)で動作します。
アプリのbuild.gradleファイルにnhncloud-creditcard-recognizer依存関係を追加します。
dependencies {
...
// NHN Cloud Credit Card Recognizer
implementation 'com.nhncloud.android:nhncloud-creditcard-recognizer:1.8.5'
}
Credit Card Recognizerを使用するにはManifest.permission.CAMERA権限が必要です。 Credit Card Recognizerを始める前にカメラ権限を取得してください。
Credit Card Recognizerインスタンスを作成します。
val creditCardRecognizer = NhnCloudOcr.newBuilder(context)
.appKey(APP_KEY)
.secretKey(SECRET_KEY)
.createCreditCardRecognizer()
CreditCardRecognizerのlaunch(Activity, CreditCardRecognitionCallback)メソッドを呼び出してクレジットカードの認識を開始します。
creditCardRecognizer.launch(activity) { result, data ->
if (result.isSuccess) {
// Success.
} else {
// Failure.
}
}
クレジットカードの認識成功時、CreditCardDataオブジェクトにクレジットカード認識データが伝達されます。 個人情報保護のために、クレジットカード番号と有効期限は一般文字列ではないSecureStringオブジェクトで返されます。 SecureString.charAt(index)メソッドは指定されたindexにある文字を返します。
CreditCardDataで返されるクレジットカード認識情報をStringオブジェクトで作成して使用するとセキュリティに脆弱です。
画面に表示するためにSecureTextView使用を参考してください。
val cardNumbers = creditCardData.cardNumbers
// firstNumber is a SecureString object.
val firstNumber = cardNumbers[0]
firstNumberSecureTextView.setText(firstNumber)
...
クレジットカード認識画面をユーザー定義して使用できます。 ユーザー定義画面を構成するにはCreditCardRecognizerの代わりにCreditCardRecognitionServiceを使用する必要があります。
CreditCardRecognitionServiceインスタンスを作成します。
val creditCardRecognitionService = NhnCloudOcrServices.newBuilder(context)
.appKey(APP_KEY)
.secretKey(SECRET_KEY)
.createCreditCardRecognitionService()
setCreditCardRecognitionListener()メソッドを使用してリスナーを登録します。 クレジットカードが認識された時、CreditCardRecognitionListenerを通じて結果が通知されます。
creditCardRecognitionService.setCreditCardRecognitionListener { result, data ->
if (result.isSuccess) {
// Recognition success.
creditCardRecognitionService.stop()
} else {
// Recognition failure.
}
}
カード認識後に必ずcreditCardRecognitionService.stop()を呼び出してサービスを停止する必要があります。
CreditCardRecognitionListenerに伝達されるCreditCardRecognitionDataは信頼度(confidence rating)に関係なくすべての結果を返します。 したがって、以下のように信頼度(confidence rating)をチェックして、より正確な結果を使用できます。
creditCardRecognitionService.setCreditCardRecognitionListener { result, data ->
if (result.isSuccess && isConfident(data)) {
// Recognition success.
creditCardRecognitionService.stop()
} else {
}
}
private fun isConfident(data: CreditCardRecognitionData): Boolean {
// Returns success if the number of card numbers is greater than or equal to 3
// and the confidence is greater than or equal to 0.4.
// American Express is in the format 1234-123456-12345.
with (data.cardNumbers) {
if (size < 3) {
return false
}
for (cardNumber in this) {
if (cardNumber.confidence < 0.4) {
return false
}
}
}
return true
}
クレジットカードの認識に成功した時、CreditCardRecognitionDataオブジェクトでクレジットカード認識データが伝達されます。 個人情報保護のためにクレジットカード番号と有効期限は一般文字列ではないSecureStringオブジェクトで返されます。 SecureString.charAt(index)メソッドは指定されたindexにある文字を返します。
CreditCardRecognitionDataで返されるクレジットカード認識情報をStringオブジェクトで作成して使用するとセキュリティに脆弱です。
画面に表示するためにSecureTextViewを参考してください。
val cardNumbers = creditCardData.cardNumbers
// firstCardNumber is a SecureString object.
val firstNumber = cardNumbers[0].value
firstNumberSecureTextView.setText(firstNumber)
...
ActivityまたはFragmentのLayoutに以下のようにCreditCardRecognitionCameraPreviewを追加してCamera Previewを構成します。
<androidx.constraintlayout.widget.ConstraintLayout
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent">
<com.nhncloud.android.ocr.creditcard.view.CreditCardRecognitionCameraPreview
android:id="@+id/camera_preview"
android:layout_width="match_parent"
android:layout_height="match_parent" />
</androidx.constraintlayout.widget.ConstraintLayout>
スキャンガイド領域を除く領域は半透明に見えます。 この領域の色を"app:guideBackgroundColor"プロパティを使用して設定します。
<com.nhncloud.android.ocr.creditcard.view.CreditCardRecognitionCameraPreview
android:id="@+id/camera_preview"
android:layout_width="match_parent"
android:layout_height="match_parent"
app:guideBackgroundColor="#33000000" />
スキャンガイドビューをCreditCardRecognitionCameraPreviewの下位ビューとして配置して自由に定義できます。 ユーザー定義したガイドビューは"app:guideView"プロパティを使用して設定します。
CreditCardRecognitionCameraPreviewはConstraintLayoutを継承実装されています。
スキャンガイドビューのサイズは自動的に調整されます。
<com.nhncloud.android.ocr.creditcard.view.CreditCardRecognitionCameraPreview
android:id="@+id/camera_preview"
android:layout_width="match_parent"
android:layout_height="match_parent"
app:guideView="@id/guide_view">
<com.yourapp.view.CustomGuideView
android:id="@+id/guide_view"
android:layout_width="0dp"
android:layout_height="0dp"
android:layout_marginTop="80dp"
app:layout_constraintLeft_toLeftOf="parent"
app:layout_constraintRight_toRightOf="parent">
</com.nhncloud.android.ocr.creditcard.view.CreditCardRecognitionCameraPreview>
クレジットカードが検出された時、スキャンガイドビューの色または形を変更できます。 CreditCardDetectableインタフェースを継承実装してsetDetected(Boolean)に伝達される値に基づいてガイドビューの色または形を変更します。
class CustomGuideView(
context: Context, attrs: AttributeSet?
): View(context, attrs), CreditCardDetectable {
override fun setDetected(detected: Boolean) {
if (detected) {
color = Color.GREEN
} else {
color = Color.WHITE
}
}
...
}
CreditCardRecognitionCameraPreviewのインスタンスを取得してCreditCardRecognitionServiceを開始します。
val cameraPreview = findViewById<CreditCardRecognitionCameraPreview>(R.id.camera_preview)
try {
creditCardRecognitionService.start(cameraPreview)
} catch (e: IOException) {
// Camera is not available (in use or does not exist)
}
アプリがバックグラウンドになるか、クレジットカードの認識に成功した時、creditCardRecognitionServiceを停止します。
creditCardRecognitionService.stop()
ActivityまたはFragmentのViewがDestoryされた時、creditCardRecognitionServiceを解除します。
creditCardRecognitionService.release();
ActivityまたはFragmentのライフサイクルに基づいて以下のように呼び出します。
override fun onResume() {
super.onResume()
creditCardRecognitionService.start(cameraPreview)
}
override fun onPause() {
super.onPause()
creditCardRecognitionService.stop()
}
override fun onDestroy() {
super.onDestroy()
creditCardRecognitionService.release()
}
override fun onResume() {
super.onResume()
creditCardRecognitionService.start(cameraPreview)
}
override fun onPause() {
super.onPause()
creditCardRecognitionService.stop()
}
override fun onDestroyView() {
super.onDestroyView()
creditCardRecognitionService.release()
}
クレジットカードのスキャン方向を設定します。
creditCardRecognitionService.scanOrientation =
CreditCardScanOrientation.HORIZONTAL // or CreditCardScanOrientation.HORIZONTAL
画面キャプチャ防止のためにActivityのonCreate()でsetContentView()が呼び出される前にWindowManager.LayoutParams.FLAG_SECUREを追加します。
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
window.addFlags(WindowManager.LayoutParams.FLAG_SECURE)
setContentView(R.layout.activity_main)
...
}
詳細については、 WindowManager.LayoutParams.FLAG_SECUREを参照してください。
Credit Card Recognition Serviceを起動する前に、アプリケーションを実行する端末でCredit Card Recognition Serviceを使用できる環境であることを確認できます。 この検査を実行するにはCreditCardRecognitionService.isAvailable(Context)メソッドを使用します。
if (CreditCardRecognitionService.isAvailable(context)) {
// Credit card recognition service is available.
} else {
// Credit card recognition service is not available.
}
個人情報保護のため、クレジットカードデータは一般的な文字列ではなくSecureStringオブジェクトで返されます。 クレジットカード認識情報をStringオブジェクトで作成して使うのはセキュリティーに弱いので、データを画面に表示するためSecureTextViewを使うことができます。
<com.nhncloud.android.ocr.SecureTextView
android:id="@+id/credit_card_first_number_view"
android:layout_width="match_parent"
android:layout_height="wrap_content"
app:com_nhncloud_text_color="#ffffff"
app:com_nhncloud_text_size="15sp"
app:com_nhncloud_text_style="bold"
app:com_nhncloud_letter_spacing="0.3"/>
SecureTextViewのsetTextメソッドで表示するテキストを設定します。
val cardNumbers = creditCardData.cardNumbers
val firstNumber = cardNumbers[0]
val firstNumberView = findViewById<SecureTextView>(credit_card_first_number_view)
firstNumberView.setText(namfirstNumbere)
| Method | Returns | Parameters | Descriptions |
|---|---|---|---|
| getFullCardNumber | SecureString | 全てのカード番号を返します。 | |
| getCardNumbers | SecureString[] | カード番号配列を返します。 | |
| getExpirationDate | SecureString | 有効期限を返します。 |
| Method | Returns | Parameters | Descriptions |
|---|---|---|---|
| getOriginBitmap | Bitmap | 原本イメージを返します。 | |
| getDetectedBitmap | Bitmap | 検出されたイメージを返します。 (ガイド領域のイメージが返されます。) |
|
| getResolution | String | 解像度情報を返します。 (推奨解像度以上の場合はnormal、未満はlow) |
|
| getFullCardNumber | SecureString | 全てのカード番号を返します。 | |
| getCardNumbers | CardNumber[] | カード番号データ(CardNumber)の配列が返されます。 | |
| getExpirationDate | ExpirationDate | 有効期限データ(ExpirationDate)が返されます。 | |
| getOriginJsonData | String | サーバーレスポンス結果を返します。 |
| Method | Returns | Parameters | Descriptions |
|---|---|---|---|
| getValue | SecureString | カード番号認識結果を返します。 | |
| getConfidence | String | カード番号認識結果の信頼度を返します。 | |
| getCoordinates | Coordinates | カード番号認識領域の座標リスト(Coordinates)を返します。 |
| Method | Returns | Parameters | Descriptions |
|---|---|---|---|
| getValue | SecureString | 有効期限の認識結果を返します。 | |
| getConfidence | String | 有効期限の認識結果の信頼度を返します。 | |
| getCoordinates | Coordinates | 有効期限認識領域の座標リスト(Coordinates)を返します。 |
| Method | Returns | Parameters | Descriptions |
|---|---|---|---|
| getPoints | Point[] | 座標(Point)の配列を返します。 | |
| getPoint | Point | int | 座標を返します。 - LEFT_TOP: 0 - RIGHT_TOP: 1 - RIGHT_BOTTOM: 2 - LEFT_BOTTOM: 3 |
| Method | Returns | Parameters | Descriptions |
|---|---|---|---|
| setText | SecureString | SecureTextViewに表示するテキストを設定します。 | |
| setTextSize | float | テキストサイズを設定します。 サイズ単位はsp、基本設定は14spです。 |
|
| setTextColor | int | テキスト色を設定します。 基本設定はColor.Black(0xFF000000)です。 |
|
| setTypefaceStyle | Typeface, int | テキスト書体とスタイルを設定します。 基本スタイル設定はTypeface.NORMALです。 |
|
| setLetterSpacing | float | テキストの文字間隔を設定します。 基本設定は0emです。 |