AssetHawk

QR Platform API

Integrate QR code generation, tracking, and analytics into your applications. Built for FuelSafe, SlateFusion, YourGreenBook, Container X, and any app that needs QR functionality.

Quick Start

1. Get Your API Key

Sign up at AssetHawk and navigate to Settings → API Keys

2. Make Your First Request

curl -X POST https://assethawk.com/api/v1/qr/create \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"dynamic","content":"https://example.com"}'

API Endpoints

POST/api/v1/qr/create

Create a new QR code

{
  "type": "dynamic",
  "content": "https://example.com",
  "customization": {
    "size": 256,
    "colors": {
      "foreground": "#6d28d9",
      "background": "#ffffff"
    }
  },
  "metadata": {
    "campaign": "summer_2025",
    "product_id": "ABC123"
  }
}
POST/api/v1/qr/{id}/scan

Record a QR code scan event

{
  "location": {
    "latitude": 33.7490,
    "longitude": -84.3880,
    "address": "Atlanta, GA"
  },
  "deviceInfo": {
    "type": "mobile",
    "os": "iOS"
  },
  "metadata": {
    "purpose": "product_verification"
  }
}
GET/api/v1/qr/{id}/analytics

Get analytics for a QR code

// Query parameters:
?start_date=2025-01-01
&end_date=2025-01-31
&group_by=day
POST/api/v1/webhooks

Register a webhook for events

{
  "url": "https://your-app.com/webhook",
  "events": ["qr_scanned", "qr_created"],
  "organizationId": "org_123",
  "apiKey": "qr_abc123..."
}

Integration Examples

FuelSafe Integration

Track fuel deliveries and prevent contamination

// Create QR for fuel tank POST /api/v1/qr/create { "type": "dynamic", "content": "fuelsafe://tank/123", "metadata": { "tank_id": "123", "fuel_type": "diesel", "capacity": 10000 } }

YourGreenBook Integration

Connect stores with customers via QR codes

// Create store QR POST /api/v1/qr/create { "type": "dynamic", "content": "ygb://store/456", "metadata": { "store_id": "456", "category": "restaurant", "location": "Atlanta" } }

Container X Integration

Track containers throughout supply chain

// Create container QR POST /api/v1/qr/create { "type": "static", "content": "container://TCLU4567890", "metadata": { "container_number": "TCLU4567890", "max_weight": 28000, "owner": "ABC Logistics" } }

SlateFusion Integration

Manage film production equipment and access

// Create equipment QR POST /api/v1/qr/create { "type": "dynamic", "content": "slate://equipment/789", "metadata": { "equipment_id": "789", "department": "camera", "production": "Marvel_001" } }

Response Format

Successful QR Creation Response

{
  "success": true,
  "data": {
    "qr_id": "abc123def4",
    "type": "dynamic",
    "content": "https://example.com",
    "short_url": "https://assethawk.com/s/abc123def4",
    "qr_data_url": "data:image/png;base64...",
    "download_url": "/api/v1/qr/abc123def4/download",
    "scan_url": "https://assethawk.com/s/abc123def4",
    "analytics_url": "/api/v1/qr/abc123def4/analytics",
    "created_at": "2025-01-15T14:30:00Z",
    "expires_at": null,
    "customization": {
      "size": 256,
      "colors": {
        "foreground": "#6d28d9",
        "background": "#ffffff"
      }
    },
    "metadata": {
      "campaign": "summer_2025"
    }
  }
}

Ready to integrate QR functionality?

Start with our free tier - 10 QR codes, 1000 scans per month

Get API KeyContact Sales