locksmithai
v0.1.3
Published
React Webcam component to integrate Face ID authentication in websites, made by Locksmith AI
Downloads
4
Maintainers
Readme
Locksmith AI's Authcam
Locksmith AI is a Face Authentication AI startup that aims to help developers integrate Face ID functionality in their websites. Locksmith AI's Node library provides Authcam, a React webcam component which is connected to Locksmith AI's backend API for authenticating users via Face ID.
How it Works
Register
- User clicks the Register using Face ID button, redirecting to the Authcam.
- Authcam gets the identity of the platform that the user wants to be registered on through the accessKey and secretKey.
- The user's face will be saved and trained on the website's user faces database using Microsoft Azure's face service
- The user's face and Face ID will be sent to the website's database through a JSON Response
Login
Installation
Install the package with:
npm install locksmithai
Usage
The package needs to be configured with your account's access key and secret key, which is available in the LocksmithAI Dashboard.
// react component
import { Authcam } from "locksmithai";
function App() {
const secretKey = '<YOUR_SECRET_KEY>'
const displayName = '<YOUR_DISPLAY_NAME>'
const type = '<REGISTER_OR_LOGIN>'
const uniqueId = '<YOUR_UNIQUE_ID>'
return (
<Authcam type={type} displayName={displayName} uniqueId={uniqueId} secretKey={secretKey} />
);
}
export default App;
Props
| prop | notes | | ---------------| -------------------------------------------------------------| | type | Can either be register or login | | accessKey | Can be generated from your Locksmith AI account's dashboard | | secretKey | Can be generated from your Locksmith AI account's dashboard | | displayName | Your company or website's name |
JSON Response
After every registration, Locksmith AI will automatically send API Responses containing the registered user's face and Face ID in JSON format, to update the website's user database
Register
{
"session": "register",
"keys": "register",
"register": "register"
}
Login
{
"session": "register",
"keys": "register",
"register": "register"
}