openBioAuthentication

Cập nhật lần cuối: 27/05/2022

Bắt đầu hỗ trợ ở phiên bản:

• API: 2.5.3

Lưu ý

Với API version ﹤ 2.23.0, phải gọi api login trước khi gọi api này và cần xin cấp quyền tại trang Quản lý ứng dụng

Cho phép ứng dụng mở giao diện đăng nhập sinh trắc học của thiết bị. Lưu ý: Chỉ hỗ trợ các OS chuẩn không bị Root hoặc Jailbreak.

Parameters

Object object

Property	Type	Default	Required	Description	Minimum Version
secretData	string		true	Khoá bí mật, dùng một lần cho quá trình xác thực. Bạn có thể tạo secretData = hash(accessToken + timestamp)	2.5.3
ui	object				2.5.3
requireFingerprint	boolean			Chỉ sử dụng vân tay. Hỗ trợ Android	2.5.3
success	function			Callback function khi gọi api thành công	2.5.3
fail	function			Callback function khi gọi api thất bại	2.5.3

UI Object

Property	Type	Default	Required	Description	Minimum Version
title	string	"Xác thực"		Tiêu đề form xác thực
subTitle	string	"Sử dụng sinh trắc học của bạn để xác thực"		Nội dung hướng dẫn
negativeButtonText	string	"Đóng"		Tiêu đề của Button thoát

Error code

Code	Error
108	Xác thực quá nhiều lần => Đã bị khóa Biometic
103	Xác thực không thành công (Bấm nhập mật khẩu - iOS)
102	Hủy xác thực
101	Xác thực thất bại 3 lần (Android)
100	Unknown error

Sample code

import api from "zmp-sdk";

api.openBioAuthentication({
  secretData: "aGkgYmFu",
  ui: {
    title: "Biometric login for my app",
    subTitle: "Log in using your biometric credential",
    negativeButtonText: "Cancel",
  },
  success: (data) => {},
  fail: (error) => {
    const { code } = error;
    //Mô tả code các mã lỗi
    // -108: Xác thực quá nhiều lần => Đã bị khóa Biometic
    // -103: Xác thực không thành công (Bấm nhập mật khẩu - iOS)
    // -102: Hủy xác thực
    // -101: Xác thực thất bại 3 lần (Android)
    // -100: Unknown error
  },
});

// Hoặc

const openBioAuthenUI = async () => {
  try {
    const data = await api.openBioAuthentication({
      secretData: "aGkgYmFu",
      ui: {
        title: "Biometric login for my app",
        subTitle: "Log in using your biometric credential",
        negativeButtonText: "Cancel",
      },
    });
  } catch (error) {
    const { code } = error;
    //Mô tả code các mã lỗi
    // -108: Xác thực quá nhiều lần => Đã bị khóa Biometic
    // -103: Xác thực không thành công (Bấm nhập mật khẩu - iOS)
    // -102: Hủy xác thực
    // -101: Xác thực thất bại 3 lần (Android)
    // -100: Unknown error
  }
};