Dikript Vue Live Face SDK

Overview

Dikript VueJs Live Face SDK is a powerful Vue.js component library for integrating live face recognition and liveness checks into your web applications. This SDK provides an easy-to-use interface for capturing user photos, performing liveness checks, and integrating with Dikript's biometric API.

Features

• Live camera feed for face detection
• Real-time face landmark detection
• Liveness check functionality
• Customizable UI components
• Easy integration with Vue.js applications

Installation

npm install dikript-vue-live-face-sdk

Usage

1. Import and register the SDK in your Vue.js application:

import { createApp } from 'vue'
import App from './App.vue'
import DikriptVueLiveFaceSDK from 'dikript-vue-live-face-sdk'

const app = createApp(App)
app.use(DikriptVueLiveFaceSDK)
app.mount('#app')

2. Use the LivenessPopup component in your Vue template:

<template>
  <div>
    <button @click="startLivenessCheck">Start Liveness Check</button>
    <LivenessPopup
      v-if="showPopup"
      :apiKey="apiKey"
      :name="name"
      :apiUrl="apiUrl"
      @closePopup="closePopup"
      @livenessResult="handleLivenessResult"
    />
  </div>
</template>

<script>
export default {
  data() {
    return {
      showPopup: false,
      apiKey: "your_api_key_here",
      name: "Your App Name",
      apiUrl: "https://api.dikript.com/dikript/api/v1/biometrics/livelinesscheck",
    };
  },
  methods: {
    startLivenessCheck() {
      this.showPopup = true;
    },
    closePopup() {
      this.showPopup = false;
    },
    handleLivenessResult(result) {
      console.log('Liveness result:', result);
      // Handle the liveness check result
    }
  }
};
</script>

API Reference

LivenessPopup Props

• apiKey (String, required): Your Dikript API key
• name (String, required): The name of your application
• apiUrl (String, required): The URL for the liveness check API endpoint

LivenessPopup Events

• closePopup: Emitted when the popup is closed
• livenessResult: Emitted with the result of the liveness check

Development

To set up the project for development:

1. Clone the repository
2. Install dependencies: npm install
3. Start the development server: npm run dev

Building

To build the SDK for production:

npm run build

Testing

• Run unit tests: npm run test:unit
• Run end-to-end tests: npm run test:e2e

License

This project is licensed under the MIT License.

Support

For any questions or support, please contact Dikript Solutions at [email protected].