Quick Start Guide

Get up and running with the face recognition API in minutes.

Quick Start Guide

Get Started in 5 Minutes

Step 1: Create Your Account (1 minute)

  1. Go to the system URL
  2. Click "Register"
  3. Fill in:
  • Your email
  • Choose a username
  • Create a password
  1. Click "Sign Up"

✅ You'll receive:

  • API Key: f1377d82a0e43f4a... (32 characters)
  • API Secret: f0a48b922f4550aa... (64 characters)

📝 IMPORTANT: Save these credentials somewhere safe!

Step 2: Log In (30 seconds)

  1. Enter your email and password
  2. Click "Login"
  3. You'll see your dashboard

Step 3: Add Your First Face (2 minutes)

Method A: Using Web Interface

  1. Click "Add Face" button on dashboard
  2. Upload a photo (JPG or PNG)
  3. Enter details:
  • Name: John Doe
  • User ID: JOHN001
  • Active: ✅ Check this box
  1. Click "Save Face"

✅ Done! Your first face is added.

Method B: Using API

# Replace YOUR_API_KEY and YOUR_API_SECRET with your actual credentials

curl -X POST "http://164.52.200.227:8000/save/" \
  -H "api_key: YOUR_API_KEY" \
  -H "api_secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "image_b64": "BASE64_ENCODED_IMAGE_HERE",
    "userId": "JOHN001",
    "user_name": "John Doe",
    "active": 1
  }'

Step 4: Search for a Face (1 minute)

Method A: Using Web Interface

  1. Click "Search" in the menu
  2. Upload an image with a face
  3. Click "Search"
  4. See results with similarity scores!

Method B: Using API

curl -X POST "http://164.52.200.227:8000/recognize/" \
  -H "api_key: YOUR_API_KEY" \
  -H "api_secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "image_b64": "BASE64_ENCODED_IMAGE_HERE"
  }'

Response:

{
  "status": true,
  "message": "Face recognized",
  "responsePacket": {
    "name": "John Doe",
    "userId": "JOHN001",
    "similarity": 0.95
  }
}

Step 5: Monitor Your Usage (30 seconds)

Check via API

# First, get your token by logging in:
curl -X POST "http://164.52.200.227:8000/auth/login/" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "your@email.com",
    "password": "your_password"
  }'

# Use the token to check usage:
curl -X GET "http://164.52.200.227:8000/auth/rate-limit-status/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response:

{
  "subscription_plan": "Free",
  "total_requests": 3,
  "limits": {
    "hourly": {"used": 3, "limit": 200, "remaining": 197},
    "daily": {"used": 3, "limit": 200, "remaining": 197},
    "monthly": {"used": 3, "limit": 2000, "remaining": 1997}
  }
}

That's It! 🎉

You're now ready to use the face recognition system.

What's Next?

  • Add more faces to build your database
  • Explore the dashboard to see all features
  • Read the full User Guide for advanced features
  • Integrate the API into your applications

Your Free Plan Includes:

✅ 2,000 requests per month ✅ 200 requests per day ✅ 200 requests per hour ✅ 2 trained tags ✅ 2 applications ✅ Full web dashboard access

Common First-Time Questions

Q: How do I convert an image to Base64?

Python:

import base64
with open("photo.jpg", "rb") as f:
    base64_image = base64.b64encode(f.read()).decode('utf-8')

JavaScript:

const fs = require('fs');
const base64_image = fs.readFileSync('photo.jpg', 'base64');

Online Tool:

  • Visit: https://www.base64-image.de/
  • Upload image → Copy Base64 string

Q: What makes a good face photo?

✅ Good Photos:

  • Clear, well-lit
  • Face looking forward
  • No sunglasses
  • High resolution
  • Single person

❌ Avoid:

  • Blurry or dark
  • Extreme angles
  • Sunglasses/masks
  • Multiple faces
  • Very small faces

Q: What if I hit my rate limit?

You'll see this error:

{
  "detail": "Hourly API limit exceeded. Limit: 200/hour. Resets in 45 minutes."
}

Solutions:

  • Wait for the limit to reset
  • Upgrade your plan
  • Optimize your code to make fewer API calls

Q: How secure are my API credentials?

🔒 Security Tips:

  • Never share your API key/secret
  • Don't commit them to GitHub
  • Store in environment variables
  • Rotate them if compromised

Need Help?

📧 Email: support@yoursystem.com 💬 Chat: Available on dashboard 📚 Full Guide: Read USER_GUIDE.md

Quick Reference Card

Save this for later:

YOUR CREDENTIALS
================
API Key: ____________________________________
API Secret: _________________________________
Token: ______________________________________

IMPORTANT URLS
==============
Dashboard: http://164.52.200.227:8000/web/dashboard
API Docs: http://164.52.200.227:8000/docs
Login: http://164.52.200.227:8000/web/login

RATE LIMITS (Free Plan)
=======================
Hourly: 200 requests
Daily: 200 requests
Monthly: 2,000 requests

SUPPORT
=======
Email: support@yoursystem.com
Phone: +1-XXX-XXX-XXXX

Welcome to Face Recognition! 🎉

Now you're ready to build amazing applications with face recognition technology.