Welcome to Dowell Logo Scan
Select an option from the menu to get started with our powerful image scanning and verification tools.
API Documentation
1. Admin Authentication API
Endpoint: POST /auth
Description: Authenticate admin users.
Request Format:
Form Data: - username: (required) Admin username - password: (required) Admin password
Response Format (Success):
{ "authenticated": true }
Response Format (Error):
HTTP 401 Unauthorized { "detail": "Authentication failed" }
2. Logo Image Upload API
Endpoint: POST /logo-image
Description: Upload an image for logo detection and storage.
Request Format:
Multipart Form Data: - image: (required) The image file to upload - category: (optional) Category of the product - product: (optional) Product name - brand: (optional) Brand name
Response Format (Success):
{ "message": "Image and features uploaded successfully" }
Response Format (Error - Duplicate):
{ "message": "Features already exist for this image" }
3. Logo Search API
Endpoint: POST /search
Description: Verify an image against stored logos.
Request Format:
Multipart Form Data: - file: (required) The image file to search
Response Format (Success):
{ "score": [ { "score": 95.5, "image_path": "https://liveuxstoryboard.com/image/123" } ], "message": "Image Exist" }
Response Format (No Match):
{ "message": "Image Not Exist" }
4. Video Upload API
Endpoint: POST /upload_video/
Description: Upload a video for frame-by-frame logo analysis.
Request Format:
Multipart Form Data: - video: (required) The video file to upload - fps: (required) Total number of pictures - category: (required) Category of the product - product: (required) Product name - brand: (required) Brand name
Response Format:
{ "message": "Upload successful, processing started" }
5. Image Retrieval API
Endpoint: GET /image/{image_id}
Description: Retrieve a stored image by its ID.
Response Format:
Binary image data with appropriate Content-Type header
Response Format (Error):
HTTP 404 Not Found (if image doesn't exist) HTTP 500 Internal Server Error (for other errors)
6. Barcode Scan API
Endpoint: POST /scan-barcode/
Description: Detect and decode barcodes from an image.
Request Format:
Multipart Form Data: - file: (required) The image file containing barcode
Response Format (Success):
{ "barcodes": [ { "data": "barcode_data", "type": "barcode_type" } ] }
Response Format (Error):
HTTP 400 Bad Request { "detail": "No barcode found in the image" }
7. OCR Scan API
Endpoint: POST /ocr-scan
Description: Extract text from an image using OCR.
Request Format:
Multipart Form Data: - image: (required) The image file to process
Response Format:
{ "ocr_text": "Extracted text from image" }
API Integration Guide
Authentication
Most endpoints require admin authentication. First authenticate using the /auth endpoint:
const authResponse = await fetch('https://liveuxstoryboard.com/auth', { method: 'POST', headers: { 'Content-Type': 'application/x-www-form-urlencoded', }, body: new URLSearchParams({ 'username': 'dowell', 'password': 'dowell' }) });
Example: Uploading a Logo Image
async function uploadLogo(imageFile, category, product, brand) { const formData = new FormData(); formData.append('image', imageFile); formData.append('category', category); formData.append('product', product); formData.append('brand', brand); const response = await fetch('https://liveuxstoryboard.com/logo-image', { method: 'POST', body: formData }); return await response.json(); }
Example: Verifying a Logo
async function verifyLogo(imageFile) { const formData = new FormData(); formData.append('image', imageFile); const response = await fetch('https://liveuxstoryboard.com/search', { method: 'POST', body: formData }); return await response.json(); }
Error Handling
Always check the response status and handle errors appropriately:
try { const response = await fetch(apiEndpoint, options); if (!response.ok) { const errorData = await response.json(); throw new Error(errorData.message || 'API request failed'); } return await response.json(); } catch (error) { console.error('API Error:', error); // Show user-friendly error message }
Upload Snapshot
Search & Verify Snapshot
Admin Login
OCR Scan Image
Upload an image to extract text using optical character recognition (OCR).
Extracted Text:
Barcode Scanner
Scan barcodes using your camera or upload an image containing a barcode.